...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Available from CRM.COM R9.1.0
| Excerpt |
|---|
This method is used to update a single Payment but only as long as it is in Draft state. |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Payment Identifier Â
The identifier of the payment that should be updated. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
...
accounts_receivable_identifier
(optional)
...
The identifier of the payment's updated accounts receivable. The allowed accounts receivable identifier fields are the following:
...
| Tip |
|---|
| From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set, then this parameter cannot be defined |
...
wallet_identifier
(optional)
...
| Tip |
|---|
Available from CRM.COM R9.1.0 |
| Excerpt |
|---|
This method is used to update a single Payment but only as long as it is in Draft state. |
Resource URL
Parameters
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Â
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Â
Request:
Body:
...
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
...
Name | Type | Description | ||||
token | String | The token retrieved from the login method | ||||
| payment_identifier (mandatory) | Payment Identifier  | The identifier of the payment that should be updated. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
|
|
In addition the following conditions apply:
- If the payment using Wallet funds functionality is not enabled through the Wallet Definition, then this parameter is not applicable
- If the accounts_receivable_identifier parameter is set, then this parameter cannot be defined
| Tip |
|---|
Available from CRM.COM R14.0.0 |
| ||
accounts_receivable_identifier (optional) |
| Accounts receivable identifier | The |
identifier of the payment |
's updated accounts receivable. The allowed accounts receivable identifier fields are the following:
|
|
|
|
|
|
| |
wallet_identifier (optional) |
| Wallet Identifier | The |
identifier of the wallet in which the payment should be allocated to. The allowed |
wallet identifier fields are the following:
|
|
In addition the following conditions apply:
| ||||
type_identifier (optional) |
| Financial transaction type identifier | The updated |
financial transaction type of the payment. |
Only financial transaction types with Payment classification can be specified. The allowed financial transaction type identifier fields are the following:
|
|
|
| ||||
category_identifier ( |
optional) |
| Financial transaction category identifier | The financial transaction category of the payment. The allowed financial transaction category identifier fields are the following:
|
|
|
|
|
|
|
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner
accounts_receivable_payment_preference_identifier
(mandatory on conditions)
payment_method_identifier (optional) | Payment Method identifier | The updated Payment Method of the payment. The allowed payment method identifier fields are the following:
|
|
|
|
|
| Tip |
|---|
card_identifier ( |
mandatory on conditions) |
| Payment Gateway Card Identifier | The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:
|
|
|
|
(optional)
received_on
(optional)
payment_amount
(optional)
intended_currency_identifier
(optional)
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner | ||||||
accounts_receivable_payment_preference_identifier (mandatory on conditions) | Accounts Receivable Payment Preference Identifier | The accounts receivable payment preferences that will be used by generic payment gateways to process the payment. The specified accounts receivable payment preferences should belong to the specified accounts receivable. This information is applicable and mandatory only if the payment will be processed by a generic payment gateway, as denoted by the selected payment method. The allowed accounts receivable payment preference identifier fields are the following:
|
|
|
notes
(optional)
received_by_user_identifier (optional) |
A back office code for the payment. If specified then it should be unique
Â
udf_string_2
(optional)
String
User Defined Field of type String
udf_string_3
(optional)
String
User Defined Field of type String
udf_string_4
(optional)
String
User Defined Field of type String
udf_string_5
(optional)
String
User Defined Field of type String
udf_string_6
(optional)
String
User Defined Field of type String
udf_string_7
(optional)
String
User Defined Field of type String
udf_string_8
(optional)
String
User Defined Field of type String
udf_float_1
(optional)
Float
User Defined Field of type Float
udf_float_2
(optional)
Float
User Defined Field of type Float
udf_float_3
(optional)
Float
User Defined Field of type Float
udf_float_4
(optional)
Float
User Defined Field of type Float
| User identifier | The user who actually received the payment. The allowed user identifier fields are the following:
| ||||||
received_by_unit_identifier (optional) |
User Defined Field of type String
| Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
| |||||||||
received_by_business_unit_identifier (optional) | Business Unit identifier | The business unit who actually received the payment. The allowed business unit identifier fields are the following:
| ||||||||
received_on (optional) | Date | The date that the payment was received. It defaults to the issued date if not specified | ||||||||
payment_amount (optional) | Number | The Payment's updated amount | ||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the payment. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| ||||||||
notes (optional) | String | Shared notes for the payment | ||||||||
back_office_code (optional) | String | A back office code for the payment. If specified then it should be unique | ||||||||
job_identifier (optional) | Job Identifier | The job for which the payment was done for. The allowed job identifier fields are the following:
| ||||||||
posted_on (optional) | Date | The posting date of the financial transaction which is before or equal to the current date and not included in already closed accounting periods. If not specified then the current date is applied.Â
| ||||||||
udf_string_1 (optional) |
| String | User Defined Field of type |
String |
udf_ |
string_2 (optional) |
String | User Defined Field of type |
String |
udf_ |
string_3 (optional) |
String | User Defined Field of type |
String |
udf_ |
string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) |
Date
User Defined Field of type Date
(optional)
The invoices that are intended to be paid
(optional)
The bills that are intended to be paid
(optional)
The service products that are intended to be paid through this payment. Applicable only if the account owner owns an effective wallet and the payment is also included as a wallet credit cause in active Wallet definititions.
| Tip |
|---|
Available from CRM.COM R14.0.0 |
fields_set
(optional)
List of Strings, comma separatedÂ
A list of fields that should be included in the results. If not specified then all the available fields will be returned
...
Float | User Defined Field of type Float | |||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||
(optional) | Set of invoice objects | The invoices that are intended to be paid
| ||||||||
(optional) | Set of bill objects | The bills that are intended to be paid
| ||||||||
(optional) | Set of product objects | The service products that are intended to be paid through this payment. Applicable only if the account owner owns an effective wallet and the payment is also included as a wallet credit cause in active Wallet definititions.
| ||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Anchor payment_update referred objects parameters payment_update referred objects parameters
Referred Parameters Objects Data
| payment_update referred objects parameters | |
| payment_update referred objects parameters |
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST Request: Body:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Response:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
| title | Example 2 |
|---|
HTTP Method: POST
Â
Request:
Body:
...
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Response:
...
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|