API

Finance APIs

PUT finance/general-ledger/{generalLedgerPostingId}/accounting-lines/{accountingLineId}

Saves information about general ledger posting item

HTTP method PUT
URI https://api.rambase.net/finance/general-ledger/{generalLedgerPostingId}/accounting-lines/{accountingLineId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {generalLedgerPostingId} General ledger posting identifier
Integer, minimum 100000
- URI parameter {accountingLineId} Accounting line identifier of the general ledger posting
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 5310, version 5

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<AccountingLine
AccountingLine

This field is optional.

>
2
     <Description
Description

Description of the general ledger posting

This field is optional.

>{String}</Description>
3
     <Intercompany
Intercompany

This field is optional.

>
4
          <Code
Code

Abbreviation/code to identify the company

This field is optional.

>{String}</Code>
5
     </Intercompany>
6
     <AccountDimensions
AccountDimensions

This field is optional.

>
7
          <GeneralLedgerAccount
GeneralLedgerAccount

This field is optional.

>
8
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

>{Integer}</GeneralLedgerAccountId>
9
          </GeneralLedgerAccount>
10
          <Dimensions
Dimensions

This field is optional.

>
11
               <Dimension
Dimension

This field is optional.

>
12
                    <Value
Value

Value for this dimension defintion.

This field is optional.

>{String}</Value>
13
                    <DimensionDefinition
DimensionDefinition

This field is optional.

>
14
                         <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

Minimum value: 1

This field is optional.

>{Integer}</DimensionDefinitionId>
15
                    </DimensionDefinition>
16
               </Dimension>
17
          </Dimensions>
18
     </AccountDimensions>
19
     <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
20
          <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
21
     </VATCodeDefinition>
22
     <Location
Location

Location of general ledger posting item.

This field is optional.

>
23
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
24
     </Location>
25
     <Totals
Totals

This field is optional.

>
26
          <Currency
Currency

Three character code following the ISO 4217 standard

This field is optional.

>{String}</Currency>
27
          <Amount
Amount

Total amount.

This field is optional.

>{Decimal}</Amount>
28
     </Totals>
29
     <TotalsConverted
TotalsConverted

This field is optional.

>
30
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is optional.

>{Decimal}</ExchangeRate>
31
     </TotalsConverted>
32
</AccountingLine>
1
{
2
     "accountingLine
AccountingLine

This field is optional.

": {
3
          "description
Description

Description of the general ledger posting

This field is optional.

": "{String}",
4
          "intercompany
Intercompany

This field is optional.

": {
5
               "code
Code

Abbreviation/code to identify the company

This field is optional.

": "{String}"
6
          },
7
          "accountDimensions
AccountDimensions

This field is optional.

": {
8
               "generalLedgerAccount
GeneralLedgerAccount

This field is optional.

": {
9
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
10
               },
11
               "dimensions
Dimensions

This field is optional.

": [
12
                    {
13
                         "value
Value

Value for this dimension defintion.

This field is optional.

": "{String}",
14
                         "dimensionDefinition
DimensionDefinition

This field is optional.

": {
15
                              "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

Minimum value: 1

This field is optional.

": "{Integer}"
16
                         }
17
                    }
18
               ]
19
          },
20
          "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
21
               "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
22
          },
23
          "location
Location

Location of general ledger posting item.

This field is optional.

": {
24
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
25
          },
26
          "totals
Totals

This field is optional.

": {
27
               "currency
Currency

Three character code following the ISO 4217 standard

This field is optional.

": "{String}",
28
               "amount
Amount

Total amount.

This field is optional.

": "{Decimal}"
29
          },
30
          "totalsConverted
TotalsConverted

This field is optional.

": {
31
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is optional.

": "{Decimal}"
32
          }
33
     }
34
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 101488 HTTP 400 Illegal general ledger account : {0}
Error 105186 HTTP 400 Postings are not allowed on control accounts.
Error 101490 HTTP 400 Illegal Account {0}: This account has been blocked for {1}-documents
Error 101491 HTTP 400 Illegal Account {0}: Check the account's FromPeriod and ToPeriod
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}