Finance APIs
Account details for provided identifier
HTTP method | GET |
URI | https://api.rambase.net/finance/general-ledger-accounts/{generalLedgerAccountId}?periodForTotals={periodId}¤cyForTotals={currency}&departmentForTotals={departmentId}&financeProjectForTotals={financeProjectId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {generalLedgerAccountId} |
General ledger account identifier
Integer, minimum 1000 |
Successful HTTP status code | 200 |
API resource identifier | 490, version 42 |
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.
periodForTotals Integer, optional |
Accounting period identifier
Minimum: 199000, Maximum: 299912 |
currencyForTotals String, optional |
Three character code following the ISO 4217 standard
Regular expression: ^[A-Z]{3}$ |
departmentForTotals Integer, optional |
Department identifier used for filtering the account totals
Minimum: 1 |
financeProjectForTotals Integer, optional |
Finance project identifier used for filtering the account totals
Minimum: 1 |
$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.
GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>Status
Status of general ledger account
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of general ledger account
>{String}</Name>PostingType
Posting type of account. Only debit, only credit or both.
Possible domain values can be found here
>{String}</PostingType>Description
Description of account
>{String}</Description>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>IsAgioCalculated
True if general ledger account is agio calculated
>{Boolean}</IsAgioCalculated>TreeLevel
Level in the general ledger account tree. 0 is the root.
>{Integer}</TreeLevel>IsControlAccount
True if general ledger account is a control account
>{Boolean}</IsControlAccount>VATPercent
Value added tax percent
>{Decimal}</VATPercent>LocationRequirement
Specifies how the location should be used for the specific account.
Possible domain values can be found here
>{String}</LocationRequirement>IntercompanyCodeRequirement
Specifies how the intercompany code should be used for the specific account.
Possible domain values can be found here
>{String}</IntercompanyCodeRequirement>TransferToFixedAsset
Specifies how investments should be transfered into the fixed assets register.
Possible domain values can be found here
>{String}</TransferToFixedAsset>LastGeneralLedgerPostingPeriod
Last general ledger posting period of account
>{Integer}</LastGeneralLedgerPostingPeriod>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>EffectivePeriod
Period the account is effective/valid from
>{Integer}</EffectivePeriod>ExpirationPeriod
Period the account expires (is valid to)
>{Integer}</ExpirationPeriod>BudgetAccountId
Budget account identifier
>{Integer}</BudgetAccountId>AccountNumber
Code of budget
>{String}</AccountNumber>Name
Name of budget
>{String}</Name>BudgetAccountLink
Budget reference
>{String}</BudgetAccountLink>DepartmentId
Department identifier
>{Integer}</DepartmentId>Name
Name of department
>{String}</Name>DepartmentLink
Finance department reference
>{String}</DepartmentLink>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>GeneralLedgerAccountGroupId
General ledger account group identifier
>{Integer}</GeneralLedgerAccountGroupId>Code
Code of general ledger account group
>{String}</Code>Name
Name of general ledger account group
>{String}</Name>GeneralLedgerAccountGroupLink
General ledger account group reference
>{String}</GeneralLedgerAccountGroupLink>DepreciationRuleId
Depreciation rule identifier
>{Integer}</DepreciationRuleId>Name
Name of depreciation rule
>{String}</Name>DepreciationRuleLink
Depreciation rule reference
>{String}</DepreciationRuleLink>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>Name
Name of general ledger account
>{String}</Name>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>TreeLevel
Level in the general ledger account tree. 0 is the root.
>{Integer}</TreeLevel>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>SalesInvoices
GL postings from Sales Invoices are blocked for this general ledger account
>{Boolean}</SalesInvoices>SalesCreditNotes
GL postings from Sales Credit Notes are blocked for this general ledger account
>{Boolean}</SalesCreditNotes>SalesPostingAdjustments
GL postings from Sales Posting Adjustments are blocked for this general ledger account
>{Boolean}</SalesPostingAdjustments>SupplierInvoices
GL postings from Supplier Invoices are blocked for this general ledger account
>{Boolean}</SupplierInvoices>SupplierCreditNotes
GL postings from Supplier Credit Notes are blocked for this general ledger account
>{Boolean}</SupplierCreditNotes>SupplierPostingAdjustments
GL postings from Supplier Posting Adjustments are blocked for this general ledger account
>{Boolean}</SupplierPostingAdjustments>Payments
GL postings from Payments are blocked for this general ledger account
>{Boolean}</Payments>ManualGLPostings
GL postings from Manual GL Postings are blocked for this general ledger account
>{Boolean}</ManualGLPostings>GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",Status
Status of general ledger account
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of general ledger account
": "{String}",Type
Type of account
Possible domain values can be found here
": "{String}",Category
Category of account
Possible domain values can be found here
": "{String}",PostingType
Posting type of account. Only debit, only credit or both.
Possible domain values can be found here
": "{String}",Description
Description of account
": "{String}",AccountNumber
The account number of the general ledger account
": "{String}",IsAgioCalculated
True if general ledger account is agio calculated
": "{Boolean}",TreeLevel
Level in the general ledger account tree. 0 is the root.
": "{Integer}",IsControlAccount
True if general ledger account is a control account
": "{Boolean}",VATPercent
Value added tax percent
": "{Decimal}",LocationRequirement
Specifies how the location should be used for the specific account.
Possible domain values can be found here
": "{String}",IntercompanyCodeRequirement
Specifies how the intercompany code should be used for the specific account.
Possible domain values can be found here
": "{String}",TransferToFixedAsset
Specifies how investments should be transfered into the fixed assets register.
Possible domain values can be found here
": "{String}",LastGeneralLedgerPostingPeriod
Last general ledger posting period of account
": "{Integer}",UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"EffectivePeriod
Period the account is effective/valid from
": "{Integer}",ExpirationPeriod
Period the account expires (is valid to)
": "{Integer}"BudgetAccountId
Budget account identifier
": "{Integer}",AccountNumber
Code of budget
": "{String}",Name
Name of budget
": "{String}",BudgetAccountLink
Budget reference
": "{String}"DepartmentId
Department identifier
": "{Integer}",Name
Name of department
": "{String}",DepartmentLink
Finance department reference
": "{String}"VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",GeneralLedgerAccountGroupId
General ledger account group identifier
": "{Integer}",Code
Code of general ledger account group
": "{String}",Name
Name of general ledger account group
": "{String}",GeneralLedgerAccountGroupLink
General ledger account group reference
": "{String}"DepreciationRuleId
Depreciation rule identifier
": "{Integer}",Name
Name of depreciation rule
": "{String}",DepreciationRuleLink
Depreciation rule reference
": "{String}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",Name
Name of general ledger account
": "{String}",AccountNumber
The account number of the general ledger account
": "{String}",TreeLevel
Level in the general ledger account tree. 0 is the root.
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"SalesInvoices
GL postings from Sales Invoices are blocked for this general ledger account
": "{Boolean}",SalesCreditNotes
GL postings from Sales Credit Notes are blocked for this general ledger account
": "{Boolean}",SalesPostingAdjustments
GL postings from Sales Posting Adjustments are blocked for this general ledger account
": "{Boolean}",SupplierInvoices
GL postings from Supplier Invoices are blocked for this general ledger account
": "{Boolean}",SupplierCreditNotes
GL postings from Supplier Credit Notes are blocked for this general ledger account
": "{Boolean}",SupplierPostingAdjustments
GL postings from Supplier Posting Adjustments are blocked for this general ledger account
": "{Boolean}",Payments
GL postings from Payments are blocked for this general ledger account
": "{Boolean}",ManualGLPostings
GL postings from Manual GL Postings are blocked for this general ledger account
": "{Boolean}"
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 |