Finance APIs
Resource for creating new payment item
| HTTP method | POST |
| 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 |
| Successful HTTP status code | 201 |
| API resource identifier | 6661, version 7 |
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.
Counterparty
The customer or supplier involved in the payment item
This field is optional.
>ObjectId
Identifier of the object
Minimum value: 100
This field is optional.
>{Integer}</ObjectId>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>TotalAmount
Required/mandatory field
Total paid amount
>{Decimal}</TotalAmount>Counterparty
The customer or supplier involved in the payment item
This field is optional.
": {ObjectId
Identifier of the object
Minimum value: 100
This field is optional.
": "{Integer}",ObjectType
Type of object
This field is optional.
": "{String}"TotalAmount
Required/mandatory field
Total paid amount
": "{Decimal}"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.
| $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 |
| $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. |
| $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] |
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.
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>Name
Name of bank account
>{String}</Name>Type
Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...
Possible domain values can be found here
>{String}</Type>AccountNumber
Account number used to identify the bank account
>{String}</AccountNumber>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>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>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>Address
Address of the bank associated with the bank account
>Country
English name of country.
>{String}</Country>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>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>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>VATAmount
Value added tax amount in company currency.
>{Decimal}</VATAmount>TotalAmount
Total amount in company currency.
>{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>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}",Name
Name of bank account
": "{String}",Type
Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...
Possible domain values can be found here
": "{String}",AccountNumber
Account number used to identify the bank account
": "{String}",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}",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}",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}",Address
Address of the bank associated with the bank account
": {Country
English name of country.
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{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}",Currency
Three character code following the ISO 4217 standard
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",VATAmount
Value added tax amount in company currency.
": "{Decimal}",TotalAmount
Total amount in company currency.
": "{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}"
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 |