Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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

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 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)

Voucher type identifier

The identifier of the voucher type to be purchased. The allowed voucher type identifier fields are the following:

Include Page
V4:voucher_type_identifier
V4:voucher_type_identifier

sold_by_unit_identifier

(mandatory)

Unit Identifier

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:

Include Page
V4:unit_identifier
V4:unit_identifier

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:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

accounts_receivable_identifier

(optional)

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:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

voucher_value

(mandatory on conditions)

NumberThe eVoucher's value. Applicable and available only if voucher type's value options is "Variable"

description

(optional)

StringThe description of the eVoucher to be purchased

udf_string_1

(optional)

StringUser Defined Field of type String

udf_string_2

(optional)

StringUser Defined Field of type String

udf_string_3

(optional)

StringUser Defined Field of type String

udf_string_4

(optional)

StringUser Defined Field of type String

udf_string_5

(optional)

StringUser Defined Field of type String

udf_string_6

(optional)

StringUser Defined Field of type String

udf_string_7

(optional)

StringUser Defined Field of type String

udf_string_8

(optional)

StringUser 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

evoucher_products_set

(optional)

Set of Products and Product Types item objectsVoucher 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

Tip

Available from CRM.COM R10.0.0

Anchor
purchase evoucher from retailer referred parameters
purchase evoucher from retailer referred parameters
Referred Parameter Objects

...