Finance APIs
List of splittable account transactions related to specific payment item
| HTTP method | GET |
| URI | https://api.rambase.net/finance/payments/{paymentId}/items/{itemId}/splittable-accounts-transactions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {paymentId} |
Payment identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Item-/line-number of the payment.
Integer, minimum 1 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6792, version 10 |
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.
| Account Integer | Account identifier for Customer/Supplier. |
| AccountingPeriod Integer | Accounting period. |
| Currency String | Three character code following the ISO 4217 standard. |
| IntercompanyPaymentReferenceNumber String | Intercompany payment reference number. |
| IssueDate Date | Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ReferenceObjectId Integer | Identifier of the object. |
| 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
| Account Integer | Account identifier for Customer/Supplier |
| AccountingPeriod Integer | Accounting period |
| Currency String | Three character code following the ISO 4217 standard |
| IntercompanyPaymentReferenceNumber String | Intercompany payment reference number |
| IssueDate Date | Date when the document was issued. |
| ReferenceObjectId Integer | Identifier of the object |
| 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.
Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalAmount
Total amount
>{Decimal}</TotalAmount>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Status
Status of the accounts receivable transaction
Possible domain values can be found here
>{String}</Status>TranslatedDescription
Description of the accounts receivable transaction.
>{String}</TranslatedDescription>DueDate
Date the object is due to be paid
>{Date}</DueDate>IssueDate
Date when the document was issued.
>{Date}</IssueDate>SellersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
>{String}</SellersPaymentReference>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>PaymentAmount
Amount which is used for the linked payment
>{Decimal}</PaymentAmount>ObjectLink
API reference to the object
>{String}</ObjectLink>Currency
Three character code following the ISO 4217 standard
": "{String}",TotalAmount
Total amount
": "{Decimal}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Status
Status of the accounts receivable transaction
Possible domain values can be found here
": "{String}",TranslatedDescription
Description of the accounts receivable transaction.
": "{String}",Type
Type of transaction
Possible domain values can be found here
": "{String}",DueDate
Date the object is due to be paid
": "{Date}",IssueDate
Date when the document was issued.
": "{Date}",SellersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
": "{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}",PaymentAmount
Amount which is used for the linked payment
": "{Decimal}"ObjectLink
API reference to the object
": "{String}"
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 104870 HTTP 404 | Default account assignment not found |
| Error 100141 HTTP 404 | Country not found |
| Error 104869 HTTP 404 | Default account not found |