Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
NameType Description
IdStringThe ID of the retrieved voucher type
nameStringThe Name of the retrieved voucher type
alternative_codeStringThe Alternative Code of the retrieved voucher type
descriptionStringThe Description of the retrieved voucher type
classificationString

The Classification of the retrieved voucher type. The supported options are Payment Voucher, Electronic Voucher and Refund VoucherPRINTED_PAYMENT_VOUCHER, ELECTRONIC_PAYMENT_VOUCHER and REFUND_VOUCHER

Tip

Available from CRM.COM R13.1.0. Refund vouchers are available from CRM.COM R14.0.0

value_optionString

Defines if the value should be fixed or a variable. The supported options are FIXED and VARIABLE

Tip

From CRM.COM R14R13.01.0 and onwards if the voucher type classification is "Refund Electronic Voucher", then this value can only be set as VARIABLE or FIXED

From CRM.COM R14.0.0 and onwards if the voucher type classification is "Electronic Refund Voucher", then this value can only be set as VARIABLE or FIXED

valueNumberThe value of the retrieved voucher type. This information is available only if the value option is set to FIXED
extra_added_valueNumber

The extra added value of the retrieved voucher type. This information is available only if the value option is set to FIXED

Tip

From CRM.COM R14R13.01.0 and onwards if the voucher type classification is "Electronic Voucher", then this value can be set as VARIABLE or FIXED

secret_number_lengthNumberThe length of the secret number of the retrieved voucher type
 vouchervoucher_using_method String

The method which defines how the e-voucher can be used. This information is only available if the type's classification is "Electronic Voucher" and the supported options are PERSONAL, SHAREABLE

Tip

Available from CRM.COM R14R13.01.0

minimum_allowed_valueNumber

The minimum value allowed to be provided while creating an e-voucher. This information is only available if the type's value option is set to "VARIABLE" (excluding Refund Vouchers)

Tip

Available from CRM.COM R14R13.01.0


maximum_allowed_valueNumber

 The maximum value allowed to be provided while creating an e-voucher. This information is only available if the type's value option is set to "VARIABLE" (excluding Refund Vouchers)

Tip

Available from CRM.COM R14R13.01.0


udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

validity_duration

Time Period Object

The validity period that a voucher of this type will be valid, measured in days or months. This information is available only if the voucher type has a "Refund Voucher" or an "Electronic Voucher" classification

Tip

Available from CRM.COM R14R13.01.0

default_payment_typeFinancial Transaction Type Object

The type of payment that will be created on using vouchers of this type

Tip

From CRM.COM R14R13.01.0 and onwards this information is only available if the voucher type classification is "Payment Voucher" and "Electronic Voucher"

Tip

Deprecated from CRM.COM R15.0.0

default_invoice_typeFinancial Transaction Type Object

The type of invoice that will be created on using selling vouchers of this type. Applicable only when selling Printed Payment Voucher to customers or partners.

Tip

From CRM.COM R14R13.01.0 and onwards this information is only available if the voucher type classification is "Electronic Voucher"

Tip

Deprecated from CRM.COM R15.0.0


default_invoice_productProduct Object

The default product to be added on the invoice that will be created on using vouchers of this type.

Tip

From CRM.COM R14R13.01.0 and onwards this information is only available if the voucher type classification is "Electronic Voucher"

Tip

From CRM.COM R15.0.0 this product represents the voucher's product that will be used when Invoice financial transactions are generated because of various voucher processes

default_payment_cancellation_typeFinancial Transaction Type Object

The type of Payment Cancellation that will be created on cancelling vouchers of this type upon return

Tip

From CRM.COM R14R13.01.0 and onwards this information is only available if the voucher type classification is "Electronic Voucher"

Tip

Deprecated from CRM.COM R15.0.0


default_invoice_cancellation_type  Financial Transaction Type Object

 The type of Invoice Cancellation that will be created on cancelling vouchers of this type upon return

Tip

From CRM.COM R14R13.01.0 and onwards this information is only available if the voucher type classification is "Electronic Voucher"

Tip

Deprecated from CRM.COM R15.0.0


default_refund_methodRefund Method Object

Contains all refund methods that will be used for performing back-end reduction, except the Payment Gateways options

This information is only available applicable only if the voucher type classification is Refund Voucher

Tip

Available from CRM.COM R14.0.0

currencyCurrency Object

The currency in which vouchers of this type will be created

Tip

Available from CRM.COM R14.2.0

log_informationLog Information ObjectThe log information of the retrieved voucher type
products_setSet of Voucher Products ObjectsThe voucher type products that can consume the amount of money that will be paid by vouchers of this type

...

Include Page
refund_method_short
refund_method_short

Include Page
currency_short
currency_short

Include Page
log_information_short
log_information_short

...