| Tip |
|---|
From CRM.COM R14.0.0 and onwards |
| Excerpt |
|---|
This method allows purchasing a voucher of classification Electronic Voucher, through a retailer. Single voucher is purchased by each call |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
voucher_type (mandatory) | Voucher type identifier | The identifier of the voucher type to be purchased. The allowed voucher type identifier fields are the following:
| ||||||
sold_by_unit_identifier (mandatory) | Unit Identifier | The identifier of the retailer's unit that will be sell selling the eVoucher. The unit must own an accounts receivable. The allowed unit identifier fields are the following:
| ||||||
purchased_by_identifier (mandatory) | Accounts Receivable Identifier | The identifier of the accounts receivable of the customer purchasing the eVoucher. If the voucher type's usage method is "Personal" then the customer purchasing the eVoucher will also use it. The allowed accounts receivable identifier fields are the following:
| ||||||
accounts_receivable_identifier (mandatory on conditions) | Accounts Receivable Identifier | The identifier of the accounts receivable of the customer that will use the eVoucher. Defaults to the accounts receivable of the customer who purchases the eVoucher except if the eVoucher type's usage method is "Shareable" and a different customer's accounts receivable can be provided. The allowed accounts receivable identifier fields are the following:
| ||||||
voucher_value (mandatory on conditions) | Number | The eVoucher's value. Applicable and available only if voucher type's value options is "Variable" | ||||||
| description | String | The description of the eVoucher to be purchased | ||||||
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.
...