API

Finance APIs

PUT finance/payments/{paymentId}

Saves information about the payment

HTTP method PUT
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 6660, version 14

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

This field is optional.

>
2
     <RemittanceHandling
RemittanceHandling

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

This field is optional.

>{String}</RemittanceHandling>
3
     <Type
Type

Type of counterparty with whom the payment is related

Applicable domain values can be found here

This field is optional.

>{String}</Type>
4
     <CurrencyDate
CurrencyDate

Currency date of the transaction

This field is optional.

>{Date}</CurrencyDate>
5
     <Note
Note

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

This field is optional.

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

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

This field is optional.

>{String}</InternalReference>
7
     <BankPaymentReference
BankPaymentReference

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

This field is optional.

>{String}</BankPaymentReference>
8
     <BankAccount
BankAccount

This field is optional.

>
9
          <BankAccountId
BankAccountId

Bank account identifier

Minimum value: 100

This field is optional.

>{Integer}</BankAccountId>
10
     </BankAccount>
11
     <AccountingPeriod
AccountingPeriod

This field is optional.

>
12
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

Minimum value: 199000

Maximum value: 299912

This field is optional.

>{Integer}</AccountingPeriodId>
13
     </AccountingPeriod>
14
</Payment>
1
{
2
     "payment
Payment

This field is optional.

": {
3
          "remittanceHandling
RemittanceHandling

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

This field is optional.

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

Type of counterparty with whom the payment is related

Applicable domain values can be found here

This field is optional.

": "{String}",
5
          "currencyDate
CurrencyDate

Currency date of the transaction

This field is optional.

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

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

This field is optional.

": "{String}",
7
          "internalReference
InternalReference

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

This field is optional.

": "{String}",
8
          "bankPaymentReference
BankPaymentReference

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

This field is optional.

": "{String}",
9
          "bankAccount
BankAccount

This field is optional.

": {
10
               "bankAccountId
BankAccountId

Bank account identifier

Minimum value: 100

This field is optional.

": "{Integer}"
11
          },
12
          "accountingPeriod
AccountingPeriod

This field is optional.

": {
13
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

Minimum value: 199000

Maximum value: 299912

This field is optional.

": "{Integer}"
14
          }
15
     }
16
}

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.

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
1

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}