Finance APIs
Key figures for procurement balance, based on saccounts payable transactions.
| HTTP method | GET |
| URI | https://api.rambase.net/finance/accounts-payable-transactions/key-figures?groupBy={groupBy}&date={date}&period={periodId}&dueInterval={dueInterval}¤cy={currency}&rateDate={rateDate}&ratePeriod={ratePeriod}&useTransactionRate={useTransactionRate}&isOverdue={isOverdue}&isMaxOverdue={isMaxOverdue}&useTransactionCurrency={useTransactionCurrency}&includeCustomerBalance={includeCustomerBalance} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6836, version 3 |
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.
| groupBy String, optional | Grouping key of the data, f.e. PERIOD, DEPNO, ... |
| date Date, optional | Calculate balance on the specific date |
| period Integer, optional |
Calculate balance for a specific period, uses the last date of the period
Minimum: 190000, Maximum: 299999 |
| dueInterval String, optional | Speified which interval will be used to calculate the due amounts. For example "30,60" means the intervals 0-30 days, 31-60 days, 61+ days |
| currency String, optional |
The values will be shown in this currency
Regular expression: ^[A-Z]{3}$ |
| rateDate Date, optional | Date which is used to get the currency rates |
| ratePeriod Integer, optional |
Period which is used to get the currency rates, the last date in the period will be used
Minimum: 190000, Maximum: 299999 |
| useTransactionRate Boolean, optional |
The rate from the transactions will be used and the values will be shown in the company currency
Default: False |
| isOverdue Boolean, optional |
Uses only the transactions which are overdue for the calculation
Default: False |
| isMaxOverdue Boolean, optional |
Uses only the transactions which are maximum overdue for the calculation
Default: False |
| useTransactionCurrency Boolean, optional |
The currency amounts from the transactions will be used for the calculations
Default: False |
| includeCustomerBalance Boolean, optional |
Include the customer balance into the calculation, relevant for auction customers
Default: False |
| $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 |
| $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. |
| $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. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| AccountingPeriod Integer | Accounting period. |
| BuyersReferenceNumber String | Buyers reference number. |
| Currency String | Three character code following the ISO 4217 standard. |
| IntercompanyCode String | Intercompany database the supplier belongs to. |
| InvoiceAddressCountryCode String | Two-character code (ISO 3166) identifying the country. |
| IssueDate Date | Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ManufacturerShortName String | Shortname/code of the manufacturer. |
| Seller Integer | Employee identifier. Available macros: currentUser() |
| SupplierId Integer | RamBase supplier identifier. |
| SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
| SuppliersInvoiceNumber String | Suppliers/sellers reference number. Typically to an external system. |
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.
Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Description
Description of the key.
>{String}</Description>SecondaryKey
Secondary grouping key for the supplier balance
>{String}</SecondaryKey>SecondaryDescription
Description of the key.
>{String}</SecondaryDescription>Date
Date which is used for the calculations
>{Date}</Date>BalanceAmount
Balance amount
>{Decimal}</BalanceAmount>NotDueAmount
Balance amount which is not due
>{Decimal}</NotDueAmount>StartDate
Start date of invoice period
>{Date}</StartDate>EndDate
End date of invoice period
>{Date}</EndDate>Amount
Due amount
>{Decimal}</Amount>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Currency
Three character code following the ISO 4217 standard
": "{String}",Key
GroupBy key for the supplier balance
Possible domain values can be found here
": "{String}",Description
Description of the key.
": "{String}",SecondaryKey
Secondary grouping key for the supplier balance
": "{String}",SecondaryDescription
Description of the key.
": "{String}",Date
Date which is used for the calculations
": "{Date}",BalanceAmount
Balance amount
": "{Decimal}",NotDueAmount
Balance amount which is not due
": "{Decimal}",StartDate
Start date of invoice period
": "{Date}",EndDate
End date of invoice period
": "{Date}"Amount
Due amount
": "{Decimal}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 101304 HTTP 404 | Carrier not found |
| Error 100053 HTTP 403 | You have only admittance to your own suppliers |
| Error 101420 HTTP 404 | Setting definition not found |