Finance APIs
Calculate the totals of general ledger postings for provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/finance/general-ledger-accounts/{generalLedgerAccountId}/totals?period={periodId}¤cy={currency} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {generalLedgerAccountId} |
General ledger account identifier
Integer, minimum 1000 |
| Maximum page size ($top) | 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 4022, version 4 |
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.
| period Integer, optional |
Accounting period identifier
Minimum: 199000, Maximum: 299912 |
| currency String, optional |
Three character code following the ISO 4217 standard
Regular expression: ^[A-Z]{3}$ |
| $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. |
Read more about filters and sorting on how to use filter parameters and named filters.
| Asset Integer | Asset identifier. |
| DepartmentId Integer | Department identifier. |
| FinanceProjectId Integer | Finance project identifier. |
| VATCode String | Code that determines VAT rules used for VAT calculations. |
Read more about filters and sorting on how to use sortable parameters
| Asset Integer | Asset identifier |
| DepartmentId Integer | Department identifier |
| FinanceProjectId Integer | Finance project identifier |
| VATCode String | Code that determines VAT rules used for VAT calculations. |
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.
AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>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>Amount
Total amount.
>{Decimal}</Amount>DebitAmount
Total debit amount.
>{Decimal}</DebitAmount>CreditAmount
Total credit amount.
>{Decimal}</CreditAmount>AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{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}",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 |