Finance APIs

GET finance/payments/{paymentId}

Payment details for provided identifier

HTTP method	GET
URI	https://api.rambase.net/finance/payments/{paymentId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {paymentId}	Payment identifier Integer, minimum 100000
Successful HTTP status code	200
API resource identifier	510, version 61

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:

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:

                                        <Payment>
                                    

<PaymentId

PaymentId

Payment identifier

>{Integer}</PaymentId>

<RemittanceHandling

RemittanceHandling

Method of payment. Default value is retrieved from the supplier or customer

>{String}</RemittanceHandling>

<Term

Term

Terms of payment. Defaut value is retrieved from the customer or supplier

>{String}</Term>

<Type

Type

Type of counterparty with whom the payment is related

Possible domain values can be found here

>{String}</Type>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Status

Status

Status of payment

Possible domain values can be found here

>{Integer}</Status>

<RegistrationDate

RegistrationDate

Date of registration

>{Date}</RegistrationDate>

<CurrencyDate

CurrencyDate

Currency date of the transaction

>{Date}</CurrencyDate>

<SendDate

SendDate

Date when the payment was send to the bank or in PAM the payment created

>{Date}</SendDate>

<Note

Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Note>

<InternalReference

InternalReference

Payment reference. E.g. sales invoice or sales order document number.

>{String}</InternalReference>

<BankPaymentReference

BankPaymentReference

Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector

>{String}</BankPaymentReference>

<SendNumber

SendNumber

Send number

>{String}</SendNumber>

<HasDeviationOnItem

HasDeviationOnItem

If the payment has items with deviations

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

>{Boolean}</HasDeviationOnItem>

<HasSystemMessageOnItem

HasSystemMessageOnItem

If the pay has messages on items

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

>{Boolean}</HasSystemMessageOnItem>

<IsBankStatementExcluded

IsBankStatementExcluded

In case of pay with excluded bank statement

>{Boolean}</IsBankStatementExcluded>

<NumberOfCounterparties

NumberOfCounterparties

Number of unique counterparties this payment has

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

>{Integer}</NumberOfCounterparties>

<NumberOfBankStatementTransactions

NumberOfBankStatementTransactions

Number of unique bank statement transactions this payment has

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

>{Integer}</NumberOfBankStatementTransactions>

                                             <BankAccount>
                                    

<BankAccountId

BankAccountId

Bank account identifier

>{Integer}</BankAccountId>

<Name

Name

Name of bank account

>{String}</Name>

<IBAN

IBAN

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}</IBAN>

<AccountNumber

AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>

<Currency

Currency

Currency used for the bank account

>{String}</Currency>

<BankAccountLink

BankAccountLink

Bank reference

>{String}</BankAccountLink>

                                                  <Bank>
                                    

<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>

<Phone

Phone

Bank phone number

>{String}</Phone>

<Address

Address

Address of the bank associated with the bank account

<AddressLine1

AddressLine1

First address line

>{String}</AddressLine1>

<AddressLine2

AddressLine2

Second address line

>{String}</AddressLine2>

<PostalCode

PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>

<City

City

City/town/village

>{String}</City>

<Country

Country

English name of country.

>{String}</Country>

<CountryCode

CountryCode

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

>{String}</CountryCode>

                                                       </Address>
                                    

                                                  </Bank>
                                    

                                             </BankAccount>
                                    

<FirstCounterparty

FirstCounterparty

The customer or supplier involved in the payment item

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<Name

Name

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

>{String}</Name>

<FirstName

FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>

                                                  <Intercompany>
                                    

<Code

Code

Intercompany database the customer belongs to.

>{String}</Code>

                                                  </Intercompany>
                                    

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

                                             </FirstCounterparty>
                                    

<GeneralLedgerAccount

GeneralLedgerAccount

Finance account associated with the bank account

<GeneralLedgerAccountId

GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>

<AccountNumber

AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>

<Name

Name

Name of general ledger account

>{String}</Name>

<GeneralLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>

                                             </GeneralLedgerAccount>
                                    

                                             <FirstBankStatementTransaction>
                                    

<TransactionId

TransactionId

Transaction identifier of the bank statement

>{Integer}</TransactionId>

                                                  <BankStatement>
                                    

<BankStatementId

BankStatementId

Bank statement identifier

>{Integer}</BankStatementId>

<SortIndex

SortIndex

Sorting index of bank statement

>{Integer}</SortIndex>

                                                       <AccountingPeriod>
                                    

<AccountingPeriodId

AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>

<Period

Period

Accounting period

>{Integer}</Period>

<AccountingPeriodLink

AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>

                                                       </AccountingPeriod>
                                    

<BankStatementLink

BankStatementLink

Bank statement reference

>{String}</BankStatementLink>

                                                  </BankStatement>
                                    

<TransactionLink

TransactionLink

Bank statement transaction reference

>{String}</TransactionLink>

                                             </FirstBankStatementTransaction>
                                    

                                             <AccountingPeriod>
                                    

<AccountingPeriodId

AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>

<Period

Period

Accounting period

>{Integer}</Period>

<AccountingPeriodLink

AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>

                                             </AccountingPeriod>
                                    

<Assignee

Assignee

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

<UserId

UserId

User identifier

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

>{Integer}</UserId>

<Name

Name

Name of the user

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

>{String}</Name>

<FirstName

FirstName

First name of the user

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

>{String}</FirstName>

<UserLink

UserLink

User reference

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

>{String}</UserLink>

                                             </Assignee>
                                    

                                             <Totals>
                                    

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<Rate

Rate

Exchange rate of the currency

>{Decimal}</Rate>

<SubTotalAmount

SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>

<TotalAmount

TotalAmount

Total amount

>{Decimal}</TotalAmount>

                                             </Totals>
                                    

                                        </Payment>
                                    

{

                                             "payment": {
                                    

"paymentId

PaymentId

Payment identifier

": "{Integer}",

"remittanceHandling

RemittanceHandling

Method of payment. Default value is retrieved from the supplier or customer

": "{String}",

"term

Term

Terms of payment. Defaut value is retrieved from the customer or supplier

": "{String}",

"type

Type

Type of counterparty with whom the payment is related

Possible domain values can be found here

": "{String}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"status

Status

Status of payment

Possible domain values can be found here

": "{Integer}",

"registrationDate

RegistrationDate

Date of registration

": "{Date}",

"currencyDate

CurrencyDate

Currency date of the transaction

": "{Date}",

"sendDate

SendDate

Date when the payment was send to the bank or in PAM the payment created

": "{Date}",

"note

Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",

"internalReference

InternalReference

Payment reference. E.g. sales invoice or sales order document number.

": "{String}",

"bankPaymentReference

BankPaymentReference

Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector

": "{String}",

"sendNumber

SendNumber

Send number

": "{String}",

"hasDeviationOnItem

HasDeviationOnItem

If the payment has items with deviations

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

": "{Boolean}",

"hasSystemMessageOnItem

HasSystemMessageOnItem

If the pay has messages on items

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

": "{Boolean}",

"isBankStatementExcluded

IsBankStatementExcluded

In case of pay with excluded bank statement

": "{Boolean}",

"numberOfCounterparties

NumberOfCounterparties

Number of unique counterparties this payment has

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

": "{Integer}",

"numberOfBankStatementTransactions

NumberOfBankStatementTransactions

Number of unique bank statement transactions this payment has

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

": "{Integer}",

                                                  "bankAccount": {
                                    

"bankAccountId

BankAccountId

Bank account identifier

": "{Integer}",

"name

Name

Name of bank account

": "{String}",

"iBAN

IBAN

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}",

"accountNumber

AccountNumber

Account number used to identify the bank account

": "{String}",

"currency

Currency

Currency used for the bank account

": "{String}",

"bankAccountLink

BankAccountLink

Bank reference

": "{String}",

                                                       "bank": {
                                    

"sWIFTCode

SWIFTCode

": "{String}",

"phone

Phone

Bank phone number

": "{String}",

"address

Address

Address of the bank associated with the bank account

": {

"addressLine1

AddressLine1

First address line

": "{String}",

"addressLine2

AddressLine2

Second address line

": "{String}",

"postalCode

PostalCode

Postalcode/Postcode/ZIP

": "{String}",

"city

City

City/town/village

": "{String}",

"country

Country

English name of country.

": "{String}",

"countryCode

CountryCode

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

": "{String}"

}

}

},

"firstCounterparty

FirstCounterparty

The customer or supplier involved in the payment item

": {

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"name

Name

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

": "{String}",

"firstName

FirstName

Secondary name of a company or firstname of a person

": "{String}",

                                                       "intercompany": {
                                    

"code

Code

Intercompany database the customer belongs to.

": "{String}"

},

"objectLink

ObjectLink

API reference to the object

": "{String}"

},

"generalLedgerAccount

GeneralLedgerAccount

Finance account associated with the bank account

": {

"generalLedgerAccountId

GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",

"accountNumber

AccountNumber

The account number of the general ledger account

": "{String}",

"name

Name

Name of general ledger account

": "{String}",

"generalLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

": "{String}"

},

                                                  "firstBankStatementTransaction": {
                                    

"transactionId

TransactionId

Transaction identifier of the bank statement

": "{Integer}",

                                                       "bankStatement": {
                                    

"bankStatementId

BankStatementId

Bank statement identifier

": "{Integer}",

"sortIndex

SortIndex

Sorting index of bank statement

": "{Integer}",

                                                            "accountingPeriod": {
                                    

"accountingPeriodId

AccountingPeriodId

Accounting period identifier

": "{Integer}",

"period

Period

Accounting period

": "{Integer}",

"accountingPeriodLink

AccountingPeriodLink

Accounting period reference

": "{String}"

},

"bankStatementLink

BankStatementLink

Bank statement reference

": "{String}"

},

"transactionLink

TransactionLink

Bank statement transaction reference

": "{String}"

},

                                                  "accountingPeriod": {
                                    

"accountingPeriodId

AccountingPeriodId

Accounting period identifier

": "{Integer}",

"period

Period

Accounting period

": "{Integer}",

"accountingPeriodLink

AccountingPeriodLink

Accounting period reference

": "{String}"

},

"assignee

Assignee

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

": {

"userId

UserId

User identifier

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

": "{Integer}",

"name

Name

Name of the user

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

": "{String}",

"firstName

FirstName

First name of the user

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

": "{String}",

"userLink

UserLink

User reference

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

": "{String}"

},

                                                  "totals": {
                                    

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"rate

Rate

Exchange rate of the currency

": "{Decimal}",

"subTotalAmount

SubTotalAmount

Total amount of the object in object currency, excluding VAT.

": "{Decimal}",

"totalAmount

TotalAmount

Total amount

": "{Decimal}"

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Change period on payment

AOP/101965

POST

Change period including closed on payment

Change currency date on payment

AOP/101971

POST

Change bank account on payment

Remove bank statement reference

AOP/101977

POST

Get remittance status for Send number

AOP/101981

POST

Exclude payment from bank statement

AOP/101983

POST

Wait for bank confirmation

AOP/101984

POST

Mark payment as sent to bank

AOP/101985

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