API

Finance APIs

GET finance/payments/{paymentId}/items/{itemId}

Details about a specific item of an payment

HTTP method GET
URI https://api.rambase.net/finance/payments/{paymentId}/items/{itemId}
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
Successful HTTP status code 200
API resource identifier 4154, version 25

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.

Format:
1
1

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.

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.

Format:
1
<PaymentItem>
2
     <PaymentItemId
PaymentItemId

Item-/line-number of the payment.

>{Integer}</PaymentItemId>
3
     <Status
Status

Status code of the the payment item.

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Note
Note

Payment item note

>{String}</Note>
6
     <RemmitanceAdvice
RemmitanceAdvice

Payment remmitance advice

>{String}</RemmitanceAdvice>
7
     <RemmitanceAdviceDate
RemmitanceAdviceDate

Payment remmitance advice date

>{Date}</RemmitanceAdviceDate>
8
     <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
9
     <Country
Country

English name of country.

>{String}</Country>
10
     <ConfirmationDate
ConfirmationDate

Payment confirmation date

>{Date}</ConfirmationDate>
11
     <ReportingCode
ReportingCode

Payment reporting code

>{String}</ReportingCode>
12
     <ReportingText
ReportingText

Payment reporting text

>{String}</ReportingText>
13
     <SystemMessage
SystemMessage

Message on payment item

>{String}</SystemMessage>
14
     <PaymentItemBankAccount>
15
          <Name
Name

Name of bank account

>{String}</Name>
16
          <Type
Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

>{String}</Type>
17
          <AccountNumber
AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>
18
          <BankCode
BankCode

A code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

>{String}</BankCode>
19
          <Bank>
20
               <SWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

>{String}</SWIFTCode>
21
               <InternationalBankAccountNumber
InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

>{String}</InternationalBankAccountNumber>
22
               <Address
Address

Address of the bank associated with the bank account

>
23
                    <Country
Country

English name of country.

>{String}</Country>
24
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
25
               </Address>
26
          </Bank>
27
     </PaymentItemBankAccount>
28
     <Counterparty
Counterparty

The customer or supplier involved in the payment item

>
29
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
30
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
31
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
32
          <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
33
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
34
     </Counterparty>
35
     <Intercompany>
36
          <Code
Code

Intercompany database the customer belongs to.

>{String}</Code>
37
     </Intercompany>
38
     <JournalEntry
JournalEntry

Payable or receivable journal entry involved in the payment item

>
39
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
40
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
41
          <GeneralLedgerPosting>
42
               <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

>{Integer}</GeneralLedgerPostingId>
43
               <GeneralLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

>{String}</GeneralLedgerPostingLink>
44
          </GeneralLedgerPosting>
45
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
46
     </JournalEntry>
47
     <AccountsTransaction
AccountsTransaction

Accounts receivable or payable transaction involved in the payment item

>
48
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
49
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
50
          <Totals>
51
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
52
               <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
53
               <TotalAmount
TotalAmount

Total amount

>{Decimal}</TotalAmount>
54
          </Totals>
55
          <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

>
56
               <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

>{String}</Currency>
57
               <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
58
               <VATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

>{Decimal}</VATAmount>
59
               <TotalAmount
TotalAmount

Total amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
60
          </TotalsConverted>
61
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
62
     </AccountsTransaction>
63
     <VATPosting>
64
          <VATPostingId
VATPostingId

VAT Posting identifier

>{Integer}</VATPostingId>
65
          <VATPostingLink
VATPostingLink

VAT Posting reference

>{String}</VATPostingLink>
66
     </VATPosting>
67
     <Totals>
68
          <GeneralLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

>{Decimal}</GeneralLedgerPostingAmount>
69
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
70
          <CurrencyAdjustmentAmount
CurrencyAdjustmentAmount

The amount of the currency adjustment to the payment item.

>{Decimal}</CurrencyAdjustmentAmount>
71
          <DeviationAmount
DeviationAmount

Payment item deviation amount.

>{Decimal}</DeviationAmount>
72
          <DocumentAmount
DocumentAmount

Object related amount (Invoice, payment and/or credit note)

>{Decimal}</DocumentAmount>
73
          <DocumentQuantity
DocumentQuantity

Number of related documents for payment

>{Integer}</DocumentQuantity>
74
          <PaymentAdvanceAmount
PaymentAdvanceAmount

Advance/prepaid payment amount

>{Decimal}</PaymentAdvanceAmount>
75
          <TotalAmount
TotalAmount

Total paid amount

>{Decimal}</TotalAmount>
76
     </Totals>
77
</PaymentItem>
1
{
2
     "paymentItem": {
3
          "paymentItemId
PaymentItemId

Item-/line-number of the payment.

": "{Integer}",
4
          "status
Status

Status code of the the payment item.

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "note
Note

Payment item note

": "{String}",
7
          "remmitanceAdvice
RemmitanceAdvice

Payment remmitance advice

": "{String}",
8
          "remmitanceAdviceDate
RemmitanceAdviceDate

Payment remmitance advice date

": "{Date}",
9
          "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
10
          "country
Country

English name of country.

": "{String}",
11
          "confirmationDate
ConfirmationDate

Payment confirmation date

": "{Date}",
12
          "reportingCode
ReportingCode

Payment reporting code

": "{String}",
13
          "reportingText
ReportingText

Payment reporting text

": "{String}",
14
          "systemMessage
SystemMessage

Message on payment item

": "{String}",
15
          "paymentItemBankAccount": {
16
               "name
Name

Name of bank account

": "{String}",
17
               "type
Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

": "{String}",
18
               "accountNumber
AccountNumber

Account number used to identify the bank account

": "{String}",
19
               "bankCode
BankCode

A code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

": "{String}",
20
               "bank": {
21
                    "sWIFTCode
SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

": "{String}",
22
                    "internationalBankAccountNumber
InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

": "{String}",
23
                    "address
Address

Address of the bank associated with the bank account

": {
24
                         "country
Country

English name of country.

": "{String}",
25
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"
26
                    }
27
               }
28
          },
29
          "counterparty
Counterparty

The customer or supplier involved in the payment item

": {
30
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
31
               "objectType
ObjectType

Type of object

": "{String}",
32
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
33
               "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
34
               "objectLink
ObjectLink

API reference to the object

": "{String}"
35
          },
36
          "intercompany": {
37
               "code
Code

Intercompany database the customer belongs to.

": "{String}"
38
          },
39
          "journalEntry
JournalEntry

Payable or receivable journal entry involved in the payment item

": {
40
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
41
               "objectType
ObjectType

Type of object

": "{String}",
42
               "generalLedgerPosting": {
43
                    "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

": "{Integer}",
44
                    "generalLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

": "{String}"
45
               },
46
               "objectLink
ObjectLink

API reference to the object

": "{String}"
47
          },
48
          "accountsTransaction
AccountsTransaction

Accounts receivable or payable transaction involved in the payment item

": {
49
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
50
               "objectType
ObjectType

Type of object

": "{String}",
51
               "totals": {
52
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
53
                    "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
54
                    "totalAmount
TotalAmount

Total amount

": "{Decimal}"
55
               },
56
               "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

": {
57
                    "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

": "{String}",
58
                    "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

": "{Decimal}",
59
                    "vATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

": "{Decimal}",
60
                    "totalAmount
TotalAmount

Total amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=AccountsTransaction.TotalsConverted in your request URI to get this field

": "{Decimal}"
61
               },
62
               "objectLink
ObjectLink

API reference to the object

": "{String}"
63
          },
64
          "vATPosting": {
65
               "vATPostingId
VATPostingId

VAT Posting identifier

": "{Integer}",
66
               "vATPostingLink
VATPostingLink

VAT Posting reference

": "{String}"
67
          },
68
          "totals": {
69
               "generalLedgerPostingAmount
GeneralLedgerPostingAmount

Total GL posting amount

": "{Decimal}",
70
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
71
               "currencyAdjustmentAmount
CurrencyAdjustmentAmount

The amount of the currency adjustment to the payment item.

": "{Decimal}",
72
               "deviationAmount
DeviationAmount

Payment item deviation amount.

": "{Decimal}",
73
               "documentAmount
DocumentAmount

Object related amount (Invoice, payment and/or credit note)

": "{Decimal}",
74
               "documentQuantity
DocumentQuantity

Number of related documents for payment

": "{Integer}",
75
               "paymentAdvanceAmount
PaymentAdvanceAmount

Advance/prepaid payment amount

": "{Decimal}",
76
               "totalAmount
TotalAmount

Total paid amount

": "{Decimal}"
77
          }
78
     }
79
}

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