...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
From CRM.COM R14.0.0 and onwards
| Excerpt |
|---|
This method allows purchasing a voucher of classification Electronic Voucher from the organisation. 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)
...
| Tip |
|---|
From CRM.COM R14.0.0 and onwards |
| Excerpt |
|---|
This method allows purchasing a voucher of classification Electronic Voucher from the organisation. A single voucher is purchased by each call |
Resource URL
http://host_name/crmapi/rest/$version/vouchers/purchase_evoucher
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_unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be selling the eVoucher. The allowed unit identifier fields are the following:
| ||||||||
sold_by_business_unit_identifier (optional) | Business Unit Identifier | The identifier of the business unit that will be selling the eVoucher. The allowed business unit identifier fields are the following:
| ||||||||
use_funds_from (mandatory) | Enum | Defines the funding method. The allowed options are:
| ||||||||
wallet_identifier | Wallet identifier | The identifier of the wallet from which the funds will be used to purchase the voucher. The allowed wallets identifier fields are the following:
|
|
|
|
| ||||
rewards_participant_identifier (semi-optional) |
| Rewards Participant Identifier | The identifier of the |
rewards participant who will purchase the voucher using the related wallet's funds. The allowed |
rewards participant identifier fields are the following:
|
|
| ||||
purchased_by_identifier ( |
semi-optional) | 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 (semi-optional on conditions) | 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" | ||||||||
payment_type_identifier (optional) | Financial transaction type identifier | The type of the payment. If not specified, the default Payment Type of Financial Transactions Definition is used. The allowed payment type identifier fields are the following:
| ||||||||
payment_category_identifier (optional) | Financial transaction category identifier | The category of the payment. The allowed payment category identifier fields are the following:
| ||||||||
payment_method_identifier (optional) | Payment method identifier | The payment method of the payment that will be generated after purchasing the eVoucher. Only payment methods included in the payment type's allowed payment methods are allowed to be specified. If not specified, then the financial transaction type's default payment method is automatically set. 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 who is purchasing the eVoucher
| ||||||||
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 that is purchasing the eVoucher. 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:
| ||||||||
payment_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 | ||||||||
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 referred parameters purchase evoucher referred parameters
Referred Parameter Objects
| purchase evoucher referred parameters | |
| purchase evoucher referred parameters |
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST Request: Body
Response:
|
...