...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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 |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
type_identifier
(mandatory)
...
The identifier of the voucher type to be purchased. The allowed voucher type identifier fields are the following:
...
sold_by_unit_identifier
(mandatory)
...
The identifier of the retailer's unit that will be selling the eVoucher. The unit must own an accounts receivable. The allowed unit identifier fields are the following:
...
purchased_by_identifier
(mandatory)
...
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
(optional)
...
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)
...
description
(optional)
...
| Tip |
|---|
From CRM.COM R14.0.0 and onwards |
| Excerpt |
|---|
This method allows purchasing a voucher of classification Electronic Payment Voucher, through a retailer. A single voucher is purchased by each call |
Resource URL
Parameters
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
type_identifier (mandatory) | Voucher type identifier | The identifier of the voucher type to be purchased. Only voucher types of "Electronic Payment Voucher" can be selected. The allowed voucher type identifier fields are the following:
| ||||||||
sold_by_business_unit_identifier (mandatory) | Business Unit Identifier | The identifier of the retailer's business unit that will be selling the eVoucher. The business unit must own an accounts receivable. The allowed business unit identifier fields are the following:
| ||||||||
sold_by_unit_identifier (mandatory) | Unit Identifier | The identifier of the retailer's organisational that will be 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 (optional) | Accounts Receivable Identifier | The identifier of the accounts receivable of the customer that will use the eVoucher. If the voucher's usage method is "Personal", then this accounts receivable defaults to the account owner who purchased voucher. If the voucher's usage method is "Shareable", if not specified then the accounts receivable remains empty as it can be used by any account owner. 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 (optional) | String | The description of the eVoucher to be purchased | ||||||||
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 Products and Product Types item objects | Voucher products are a set of products (services and physical goods) or product types that can consume the amount of money that was paid through the eVoucher. | ||||||||
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 purchase evoucher from retailer referred parameters purchase evoucher from retailer referred parameters
Referred Parameter Objects
| purchase evoucher from retailer referred parameters | |
| purchase evoucher from retailer referred parameters |
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST Request: Body
Response:
|
...