Finance APIs
List of accounts receivable transactions.
For listing all documents linked to a payment use the following filter:
$filter=Payment.ItemReference.ObjectType eq "Payment" and Payment.ItemReference.ObjectId eq
| HTTP method | GET |
| URI | https://api.rambase.net/finance/accounts-receivable-transactions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 448, version 19 |
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 |
| $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.
| ActiveReceivTrans() Named filter | Active receivable transactions (status between 1 and 9) |
| ImportedReceivTrans() Named filter | Imported receivable transactions |
| AccountingPeriod Integer | Accounting period. |
| AccountsReceivableTransactionId Integer | Accounts receivable transaction identifier. |
| Currency String | Three character code following the ISO 4217 standard. |
| CustomerId Integer | Customer identifier. |
| CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
| IssueDate Date | Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ReferenceObjectType String | Type of object. |
| Status Integer | Status of the accounts receivable transaction. |
| TotalAmount Decimal | Total amount. |
| TotalAmountConverted Decimal | Total amount. |
| VATRegistrationNumber String | Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT). |
Read more about filters and sorting on how to use sortable parameters
| AccountingPeriod Integer | Accounting period |
| AccountsReceivableTransactionId Integer | Accounts receivable transaction identifier |
| Currency String | Three character code following the ISO 4217 standard |
| CustomerId Integer | Customer identifier |
| CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
| IssueDate Date | Date when the document was issued. |
| ReferenceObjectType String | Type of object |
| Status Integer | Status of the accounts receivable transaction |
| TotalAmount Decimal | Total amount |
| TotalAmountConverted Decimal | Total amount |
| VATRegistrationNumber String | Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT). |
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.
AccountsReceivableTransactionId
Accounts receivable transaction identifier
>{Integer}</AccountsReceivableTransactionId>Status
Status of the accounts receivable transaction
Possible domain values can be found here
>{Integer}</Status>TranslatedDescription
Description of the accounts receivable transaction.
>{String}</TranslatedDescription>DueDate
Date the object is due to be paid
>{Date}</DueDate>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>IssueDate
Date when the document was issued.
>{Date}</IssueDate>RegistrationDate
Date of registration
>{Date}</RegistrationDate>AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>Code
Intercompany database the customer belongs to.
>{String}</Code>LegalEntityIdentifier
The customers unique enterprise/organization number.
>{String}</LegalEntityIdentifier>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>CustomerLink
Customer reference
>{String}</CustomerLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Identifier of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>VATAmount
Total value added tax in object currency.
>{Decimal}</VATAmount>TotalAmount
Total amount
>{Decimal}</TotalAmount>AccountsReceivableTransactionLink
Accounts receivable transaction reference
>{String}</AccountsReceivableTransactionLink>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>AccountsReceivableTransactionId
Accounts receivable transaction identifier
": "{Integer}",Status
Status of the accounts receivable transaction
Possible domain values can be found here
": "{Integer}",TranslatedDescription
Description of the accounts receivable transaction.
": "{String}",DueDate
Date the object is due to be paid
": "{Date}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",IssueDate
Date when the document was issued.
": "{Date}",RegistrationDate
Date of registration
": "{Date}",AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{String}"CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",Code
Intercompany database the customer belongs to.
": "{String}"LegalEntityIdentifier
The customers unique enterprise/organization number.
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",CustomerLink
Customer reference
": "{String}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Identifier of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",VATAmount
Total value added tax in object currency.
": "{Decimal}",TotalAmount
Total amount
": "{Decimal}"AccountsReceivableTransactionLink
Accounts receivable transaction reference
": "{String}"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 100209 HTTP 400 | Illegal document Id {0} |
| Error 101086 HTTP 400 | Missing required argument {0} for description |
| Error 101087 HTTP 400 | Description argument/result mismatch |