Finance APIs
Details about a specific accounting line of a general ledger posting
HTTP method | GET |
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 | 4005, version 8 |
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.
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.
$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] |
$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 |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$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. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
$expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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.
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>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
>{String}</Name>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>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
": "{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
": "{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}"
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 |