POST payments/update
Available from CRM.COM R9.1.0
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 | |||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||
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:
From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set, then this parameter cannot be defined | |||||||||||||||||||||||||||
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:
Available from CRM.COM R14.0.0 | |||||||||||||||||||||||||||
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:
From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set, then this parameter cannot include Payment Gateways | |||||||||||||||||||||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment. The allowed financial transaction category identifier fields are the following:
| |||||||||||||||||||||||||||
payment_method_identifier (optional) | Payment Method identifier | The updated Payment Method of the payment. The allowed payment method identifier fields are the following:
| |||||||||||||||||||||||||||
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:
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:
| |||||||||||||||||||||||||||
received_by_user_identifier (optional) | User identifier | The user who actually received the payment. The allowed user identifier fields are the following:
| |||||||||||||||||||||||||||
received_by_unit_identifier (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | |||||||||||||||||||||||||||
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:
Available from CRM.COM R18.0.0 | |||||||||||||||||||||||||||
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. Available from CRM.COM R14.10.0 | |||||||||||||||||||||||||||
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) | 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 If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [ { "action": "update", ........... }, { "action": "remove", ........... }, { "action": "add", ........... } ] | |||||||||||||||||||||||||||
(optional) | Set of bill objects | The bills that are intended to be paid If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [ { "action": "update", ........... }, { "action": "remove", ........... }, { "action": "add", ........... } ] | |||||||||||||||||||||||||||
(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. If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [ { "action": "update", ........... }, { "action": "remove", ........... }, { "action": "add", ........... } ] Available from CRM.COM R12.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 |
Referred Parameters Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved payment |
number | String | The number of the retrieved payment |
reference_number | String | The reference number of the retrieved payment |
life_cycle_state | String | The state of the retrieved payment which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
payment_amount | Number | The amount of the payment |
issued_on | Date | The date that the payment was issued |
posted_on | Date | The date that the payment was posted |
received_on | Date | The date that the payment was received |
notes | String | Shared notes for the payment |
processed_by_payment_gateway | String | The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
payment_gateway_reference_number | String | A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
back_office_code | String | The back office code of the retrieved payment |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
accounts_receivable | Accounts Receivable Object | The related accounts receivable For releases prior CRM.COM R14.0.0, the related Accounts Receivable Object is retrieved always From CRM.COM R14.0.0 and onwards, Accounts Receivable Object will be retrieved only if the payment was posted against it |
voucher | Voucher Object | The related voucher Available from CRM.COM R14.0.0 |
type | Financial transaction type object | The financial transaction type of the payment |
category | Financial transaction category object | The category of the payment |
payment_method | Payment method object | The payment method of that payment |
received_by_user | User object | The user who actually received the payment |
received_by_unit | Unit object | The unit who actually received the payment Deprecated from CRM.COM R18.0.0 |
received_by_business_unit | Business Unit object | The business unit who actually received the payment Available from CRM.COM R18.0.0 |
rejection_reason | Financial transaction rejection reason object | The reason that the payment was rejected |
card | Payment Gateway Card Object | The card that was charged by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
payment_preference | Accounts Receivable Payment Preference Object | The accounts receivable payment preference that were used by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
accounting_period_information | Accounting Period Information object | The accounting period information of the retrieved payment. This is applicable only if the payment was processed within an Accounting Period Closing process run. Available from CRM.COM R10.0.0 |
currency_rate_period | Currency Rate Period object | The currency rate period based on which the payment's amounts were calculated Available from CRM.COM R10.0.0 |
invoices_to_pay_set | Set of invoice objects | The invoices that were intended to be paid |
bills_to_pay_set | Set of bill objects | The bills that were intended to be paid |
products_to_pay_set | Set of products | The products that were intended to be paid Available from CRM.COM R12.0.0 |
bills_paid | Set of bill objects | The bill(s) actually paid through the payment Available from CRM.COM R14.28.0 |
payment_cancellation | Payment Cancellation Object | The payment cancellation related with the retrieved payment, if it was cancelled Available from CRM.COM R14.5.0 |
Log Information Object | The log information related with the retrieved payment |
Referred Objects Response Data