Finance APIs
List of payment items
| HTTP method | GET |
| URI | https://api.rambase.net/finance/payments/{paymentId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {paymentId} |
Payment identifier
Integer, minimum 100000 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6491, version 9 |
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.
| AccountsTransactionId Integer | Identifier of the object. |
| ConfirmationDate Date | Payment confirmation date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| CounterpartyId Integer | Identifier of the object. |
| CounterpartyObjectType String | Type of object. |
| CountryCode String | Two-character code (ISO 3166) identifying the country. |
| Currency String | Three character code following the ISO 4217 standard. |
| CurrencyAdjustmentAmount Decimal | The amount of the currency adjustment to the payment item. |
| DeviationAmount Decimal | Payment item deviation amount. |
| DocumentAmount Decimal | Object related amount (Invoice, payment and/or credit note). |
| DocumentQuantity Integer | Number of related documents for payment. |
| GeneralLedgerPostingAmount Decimal | Total GL posting amount. |
| IntercompanyCode String | Intercompany database the customer belongs to. |
| JournalEntryId Integer | Identifier of the object. |
| Note String | Payment item note. |
| PaymentAdvanceAmount Decimal | Advance/prepaid payment amount. |
| PaymentItemId Integer | Item-/line-number of the payment. |
| RemmitanceAdvice String | Payment remmitance advice. |
| RemmitanceAdviceDate Date | Payment remmitance advice date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ReportingCode String | Payment reporting code. |
| ReportingText String | Payment reporting text. |
| Status Integer | Status code of the the payment item. |
| SystemMessage String | Message on payment item. |
| TotalAmount Decimal | Total paid amount. |
Read more about filters and sorting on how to use sortable parameters
| AccountsTransactionId Integer | Identifier of the object |
| ConfirmationDate Date | Payment confirmation date |
| CounterpartyId Integer | Identifier of the object |
| CounterpartyObjectType String | Type of object |
| CountryCode String | Two-character code (ISO 3166) identifying the country. |
| Currency String | Three character code following the ISO 4217 standard |
| CurrencyAdjustmentAmount Decimal | The amount of the currency adjustment to the payment item. |
| DeviationAmount Decimal | Payment item deviation amount. |
| DocumentAmount Decimal | Object related amount (Invoice, payment and/or credit note) |
| DocumentQuantity Integer | Number of related documents for payment |
| GeneralLedgerPostingAmount Decimal | Total GL posting amount |
| IntercompanyCode String | Intercompany database the customer belongs to. |
| JournalEntryId Integer | Identifier of the object |
| Note String | Payment item note |
| PaymentAdvanceAmount Decimal | Advance/prepaid payment amount |
| PaymentItemId Integer | Item-/line-number of the payment. |
| RemmitanceAdvice String | Payment remmitance advice |
| RemmitanceAdviceDate Date | Payment remmitance advice date |
| ReportingCode String | Payment reporting code |
| ReportingText String | Payment reporting text |
| Status Integer | Status code of the the payment item. |
| SystemMessage String | Message on payment item |
| TotalAmount Decimal | Total paid amount |
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.
PaymentItemId
Item-/line-number of the payment.
>{Integer}</PaymentItemId>Status
Status code of the the payment item.
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Note
Payment item note
>{String}</Note>RemmitanceAdvice
Payment remmitance advice
>{String}</RemmitanceAdvice>RemmitanceAdviceDate
Payment remmitance advice date
>{Date}</RemmitanceAdviceDate>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>ConfirmationDate
Payment confirmation date
>{Date}</ConfirmationDate>ReportingCode
Payment reporting code
>{String}</ReportingCode>ReportingText
Payment reporting text
>{String}</ReportingText>SystemMessage
Message on payment item
>{String}</SystemMessage>Counterparty
The customer or supplier involved in the payment item
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>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>ObjectLink
API reference to the object
>{String}</ObjectLink>Code
Intercompany database the customer belongs to.
>{String}</Code>JournalEntry
Payable or receivable journal entry involved in the payment item
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>GeneralLedgerPostingId
General ledger posting identifier
>{Integer}</GeneralLedgerPostingId>GeneralLedgerPostingLink
General ledger posting reference
>{String}</GeneralLedgerPostingLink>ObjectLink
API reference to the object
>{String}</ObjectLink>AccountsTransaction
Accounts receivable or payable transaction involved in the payment item
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>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>ObjectLink
API reference to the object
>{String}</ObjectLink>VATPostingId
VAT Posting identifier
>{Integer}</VATPostingId>VATPostingLink
VAT Posting reference
>{String}</VATPostingLink>GeneralLedgerPostingAmount
Total GL posting amount
>{Decimal}</GeneralLedgerPostingAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>CurrencyAdjustmentAmount
The amount of the currency adjustment to the payment item.
>{Decimal}</CurrencyAdjustmentAmount>DeviationAmount
Payment item deviation amount.
>{Decimal}</DeviationAmount>DocumentAmount
Object related amount (Invoice, payment and/or credit note)
>{Decimal}</DocumentAmount>DocumentQuantity
Number of related documents for payment
>{Integer}</DocumentQuantity>PaymentAdvanceAmount
Advance/prepaid payment amount
>{Decimal}</PaymentAdvanceAmount>TotalAmount
Total paid amount
>{Decimal}</TotalAmount>PaymentItemLink
Bank reference
>{String}</PaymentItemLink>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>PaymentItemId
Item-/line-number of the payment.
": "{Integer}",Status
Status code of the the payment item.
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Note
Payment item note
": "{String}",RemmitanceAdvice
Payment remmitance advice
": "{String}",RemmitanceAdviceDate
Payment remmitance advice date
": "{Date}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",ConfirmationDate
Payment confirmation date
": "{Date}",ReportingCode
Payment reporting code
": "{String}",ReportingText
Payment reporting text
": "{String}",SystemMessage
Message on payment item
": "{String}",Counterparty
The customer or supplier involved in the payment item
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",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}",ObjectLink
API reference to the object
": "{String}"Code
Intercompany database the customer belongs to.
": "{String}"JournalEntry
Payable or receivable journal entry involved in the payment item
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",GeneralLedgerPostingId
General ledger posting identifier
": "{Integer}",GeneralLedgerPostingLink
General ledger posting reference
": "{String}"ObjectLink
API reference to the object
": "{String}"AccountsTransaction
Accounts receivable or payable transaction involved in the payment item
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",VATAmount
Total value added tax in object currency.
": "{Decimal}",TotalAmount
Total amount
": "{Decimal}"ObjectLink
API reference to the object
": "{String}"VATPostingId
VAT Posting identifier
": "{Integer}",VATPostingLink
VAT Posting reference
": "{String}"GeneralLedgerPostingAmount
Total GL posting amount
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",CurrencyAdjustmentAmount
The amount of the currency adjustment to the payment item.
": "{Decimal}",DeviationAmount
Payment item deviation amount.
": "{Decimal}",DocumentAmount
Object related amount (Invoice, payment and/or credit note)
": "{Decimal}",DocumentQuantity
Number of related documents for payment
": "{Integer}",PaymentAdvanceAmount
Advance/prepaid payment amount
": "{Decimal}",TotalAmount
Total paid amount
": "{Decimal}"PaymentItemLink
Bank 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 100050 HTTP 403 | No admittance as customer {0} |
| Error 100053 HTTP 403 | You have only admittance to your own suppliers |