Finance APIs
Resource for creating new payment
| HTTP method | POST |
| URI | https://api.rambase.net/finance/payments |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 6659, version 8 |
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.
RemittanceHandling
Method of payment. Default value is retrieved from the supplier or customer
This field is optional.
>{String}</RemittanceHandling>Type
Required/mandatory field
Type of counterparty with whom the payment is related
Applicable domain values can be found here
>{String}</Type>CurrencyDate
Currency date of the transaction
This field is optional.
>{Date}</CurrencyDate>BankAccountId
Required/mandatory field
Bank account identifier
Minimum value: 100
>{Integer}</BankAccountId>RemittanceHandling
Method of payment. Default value is retrieved from the supplier or customer
This field is optional.
": "{String}",Type
Required/mandatory field
Type of counterparty with whom the payment is related
Applicable domain values can be found here
": "{String}",CurrencyDate
Currency date of the transaction
This field is optional.
": "{Date}",BankAccountId
Required/mandatory field
Bank account identifier
Minimum value: 100
": "{Integer}"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.
PaymentId
Payment identifier
>{Integer}</PaymentId>RemittanceHandling
Method of payment. Default value is retrieved from the supplier or customer
>{String}</RemittanceHandling>Term
Terms of payment. Defaut value is retrieved from the customer or supplier
>{String}</Term>Type
Type of counterparty with whom the payment is related
Possible domain values can be found here
>{String}</Type>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RegistrationDate
Date of registration
>{Date}</RegistrationDate>CurrencyDate
Currency date of the transaction
>{Date}</CurrencyDate>SendDate
Date when the payment was send to the bank or in PAM the payment created
>{Date}</SendDate>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
>{String}</Note>InternalReference
Payment reference. E.g. sales invoice or sales order document number.
>{String}</InternalReference>BankPaymentReference
Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector
>{String}</BankPaymentReference>SendNumber
Send number
>{String}</SendNumber>IsBankStatementExcluded
In case of pay with excluded bank statement
>{Boolean}</IsBankStatementExcluded>BankAccountId
Bank account identifier
>{Integer}</BankAccountId>Name
Name of bank account
>{String}</Name>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
Account number used to identify the bank account
>{String}</AccountNumber>Currency
Currency used for the bank account
>{String}</Currency>BankAccountLink
Bank reference
>{String}</BankAccountLink>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
Bank phone number
>{String}</Phone>Address
Address of the bank associated with the bank account
>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Country
English name of country.
>{String}</Country>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>FirstCounterparty
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>Code
Intercompany database the customer belongs to.
>{String}</Code>ObjectLink
API reference to the object
>{String}</ObjectLink>GeneralLedgerAccount
Finance account associated with the bank account
>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>Name
Name of general ledger account
>{String}</Name>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>TransactionId
Transaction identifier of the bank statement
>{Integer}</TransactionId>BankStatementId
Bank statement identifier
>{Integer}</BankStatementId>SortIndex
Sorting index of bank statement
>{Integer}</SortIndex>AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>BankStatementLink
Bank statement reference
>{String}</BankStatementLink>TransactionLink
Bank statement transaction reference
>{String}</TransactionLink>AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Rate
Exchange rate of the currency
>{Decimal}</Rate>SubTotalAmount
Total amount of the object in object currency, excluding VAT.
>{Decimal}</SubTotalAmount>TotalAmount
Total amount
>{Decimal}</TotalAmount>PaymentId
Payment identifier
": "{Integer}",RemittanceHandling
Method of payment. Default value is retrieved from the supplier or customer
": "{String}",Term
Terms of payment. Defaut value is retrieved from the customer or supplier
": "{String}",Type
Type of counterparty with whom the payment is related
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of payment
Possible domain values can be found here
": "{Integer}",RegistrationDate
Date of registration
": "{Date}",CurrencyDate
Currency date of the transaction
": "{Date}",SendDate
Date when the payment was send to the bank or in PAM the payment created
": "{Date}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
": "{String}",InternalReference
Payment reference. E.g. sales invoice or sales order document number.
": "{String}",BankPaymentReference
Payment reference number. E.g. information about the data source, such as that it is imported from bankconnector
": "{String}",SendNumber
Send number
": "{String}",IsBankStatementExcluded
In case of pay with excluded bank statement
": "{Boolean}",BankAccountId
Bank account identifier
": "{Integer}",Name
Name of bank account
": "{String}",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
Account number used to identify the bank account
": "{String}",Currency
Currency used for the bank account
": "{String}",BankAccountLink
Bank reference
": "{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}",Phone
Bank phone number
": "{String}",Address
Address of the bank associated with the bank account
": {AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Country
English name of country.
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}"FirstCounterparty
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}",Code
Intercompany database the customer belongs to.
": "{String}"ObjectLink
API reference to the object
": "{String}"GeneralLedgerAccount
Finance account associated with the bank account
": {GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",AccountNumber
The account number of the general ledger account
": "{String}",Name
Name of general ledger account
": "{String}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"TransactionId
Transaction identifier of the bank statement
": "{Integer}",BankStatementId
Bank statement identifier
": "{Integer}",SortIndex
Sorting index of bank statement
": "{Integer}",AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{String}"BankStatementLink
Bank statement reference
": "{String}"TransactionLink
Bank statement transaction reference
": "{String}"AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{String}",UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",Rate
Exchange rate of the currency
": "{Decimal}",SubTotalAmount
Total amount of the object in object currency, excluding VAT.
": "{Decimal}",TotalAmount
Total 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 |
| Error 106190 HTTP 400 | Period on payment can't be earlier than period on linked transactions : {0} |