Finance APIs
Resource for creating new general ledger posting line
HTTP method | POST |
URI | https://api.rambase.net/finance/general-ledger/{generalLedgerPostingId}/accounting-lines |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {generalLedgerPostingId} |
General ledger posting identifier
Integer, minimum 100000 |
Successful HTTP status code | 201 |
API resource identifier | 5290, 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.
Description
Description of the general ledger posting
This field is optional.
>{String}</Description>Intercompany
This field is optional.
>Code
Abbreviation/code to identify the company
This field is optional.
>{String}</Code>GeneralLedgerAccountId
Required/mandatory field
General ledger account identifier
Minimum value: 1000
>{Integer}</GeneralLedgerAccountId>Dimensions
This field is optional.
>Dimension
This field is optional.
>Value
Value for this dimension defintion.
This field is optional.
>{String}</Value>DimensionDefinition
This field is optional.
>DimensionDefinitionId
Dimension identifier
Minimum value: 1
This field is optional.
>{Integer}</DimensionDefinitionId>VATCodeDefinition
This field is optional.
>VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
>{String}</VATCode>Location
Location of general ledger posting item.
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Currency
Three character code following the ISO 4217 standard
This field is optional.
>{String}</Currency>Amount
Required/mandatory field
Total amount.
>{Decimal}</Amount>TotalsConverted
This field is optional.
>ExchangeRate
The exchange rate used in convertion
This field is optional.
>{Decimal}</ExchangeRate>Description
Description of the general ledger posting
This field is optional.
": "{String}",Intercompany
This field is optional.
": {Code
Abbreviation/code to identify the company
This field is optional.
": "{String}"GeneralLedgerAccountId
Required/mandatory field
General ledger account identifier
Minimum value: 1000
": "{Integer}"Dimensions
This field is optional.
": [Value
Value for this dimension defintion.
This field is optional.
": "{String}",DimensionDefinition
This field is optional.
": {DimensionDefinitionId
Dimension identifier
Minimum value: 1
This field is optional.
": "{Integer}"VATCodeDefinition
This field is optional.
": {VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
": "{String}"Location
Location of general ledger posting item.
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Currency
Three character code following the ISO 4217 standard
This field is optional.
": "{String}",Amount
Required/mandatory field
Total amount.
": "{Decimal}"TotalsConverted
This field is optional.
": {ExchangeRate
The exchange rate used in convertion
This field is optional.
": "{Decimal}"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. |
$showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
$lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
AccountingLineId
Accounting line identifier of the general ledger posting
>{Integer}</AccountingLineId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>VATPercent
Value added tax percent
>{Decimal}</VATPercent>Description
Description of the general ledger posting
>{String}</Description>Code
Abbreviation/code to identify the company
>{String}</Code>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>Name
Name of general ledger account
>{String}</Name>Type
Type of account
Possible domain values can be found here
>Requirement
Specifies how the dimension should be used for the specific account.
Possible domain values can be found here
>{String}</Requirement>DimensionDefinitionId
Dimension identifier
>{Integer}</DimensionDefinitionId>Name
Name of dimension
>{String}</Name>ValueSource
Where the value is selected from.
>DimensionDefinitionLink
Dimension reference
>{String}</DimensionDefinitionLink>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Value
Value for this dimension defintion.
>{String}</Value>Description
Description of the dimension value.
>{String}</Description>DimensionDefinitionId
Dimension identifier
>{Integer}</DimensionDefinitionId>Name
Name of dimension
>{String}</Name>DimensionDefinitionLink
Dimension reference
>{String}</DimensionDefinitionLink>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>Description
Description of VAT Code definition
>{String}</Description>Location
Location of general ledger posting item.
>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>Name
Name of warehouse location
>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Amount
Total amount.
>{Decimal}</Amount>DebitAmount
Total debit amount.
>{Decimal}</DebitAmount>CreditAmount
Total credit amount.
>{Decimal}</CreditAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>Amount
Total amount in company currency.
>{Decimal}</Amount>DebitAmount
Total debit amount in company currency.
>{Decimal}</DebitAmount>CreditAmount
Total credit amount in company currency.
>{Decimal}</CreditAmount>AccountingLineId
Accounting line identifier of the general ledger posting
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",VATPercent
Value added tax percent
": "{Decimal}",Description
Description of the general ledger posting
": "{String}",Code
Abbreviation/code to identify the company
": "{String}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",AccountNumber
The account number of the general ledger account
": "{String}",Name
Name of general ledger account
": "{String}",Type
Type of account
Possible domain values can be found here
": {Requirement
Specifies how the dimension should be used for the specific account.
Possible domain values can be found here
": "{String}",DimensionDefinitionId
Dimension identifier
": "{Integer}",Name
Name of dimension
": "{String}",ValueSource
Where the value is selected from.
": {Type
Type of source
Possible domain values can be found here
": "{String}"DimensionDefinitionLink
Dimension reference
": "{String}"GeneralLedgerAccountLink
General ledger account reference
": "{String}"Value
Value for this dimension defintion.
": "{String}",Description
Description of the dimension value.
": "{String}",DimensionDefinitionId
Dimension identifier
": "{Integer}",Name
Name of dimension
": "{String}",DimensionDefinitionLink
Dimension reference
": "{String}"VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",Description
Description of VAT Code definition
": "{String}"Location
Location of general ledger posting item.
": {ShortName
Unique abbreviation/short name of the location
": "{String}",Name
Name of warehouse location
": {CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",Amount
Total amount.
": "{Decimal}",DebitAmount
Total debit amount.
": "{Decimal}",CreditAmount
Total credit amount.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",Amount
Total amount in company currency.
": "{Decimal}",DebitAmount
Total debit amount in company currency.
": "{Decimal}",CreditAmount
Total credit amount in company currency.
": "{Decimal}"
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 100169 HTTP 404 | General ledger account not found : {0} |
Error 100563 HTTP 400 | Currency {0} is not supported by the system |