| Tip |
|---|
From CRM.COM R13.1.0 and onwards the process of using a voucher is enhanced as follows:
From CRM.COM R14.0.0 and onwards the process of using a voucher is enhanced as follows:
|
| Excerpt |
|---|
This method uses a voucher. Single voucher is used by each call |
Resource URL
http://host_name/crmapi/rest/$version/vouchers/use
Parameters
Name | Type | Description | |||||||||||||
token | String | The token retrieved from the login method | |||||||||||||
| secret_number (mandatory on conditions) | String | The secret number of the voucher that will be used
| |||||||||||||
accounts_receivable_identifier | Accounts receivable identifier | The identifier of the account receivable that the payment should be allocated in. The allowed accounts receivable identifier fields are the following:
| customer_identification_medium_value (mandatory on conditions) | String | The value of the customer identification medium related to the contact owning the voucher. It is used to identify vouchers of type category "identifies customer"
| ||||||||||
| payment_category_identifier (optional) | Payment category identifier | The identifier of the payment category related with the payment that will be created. The allowed payment category identifier fields are the following:
| |||||||||||||
notes | Notes Object | The notes for the payment to be created | |||||||||||||
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
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...