Page Comparison

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Name

Type

Description

Id

String

The ID of the retrieved voucher type

name

String

The Name of the retrieved voucher type

alternative_code

String

The Alternative Code of the retrieved voucher type

description

String

The Description of the retrieved voucher type

classification

String

The Classification of the retrieved voucher type. The supported options are Payment Voucher and Refund Voucher

Tip
Available from CRM.COM R14.0.0

value_option

String

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

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

value

Number

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

extra_added_value

Number

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

secret_number_length

Number

The length of the secret number of the retrieved voucher type

validity_duration

Number

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

Tip
Available from CRM.COM R14.0.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

default_payment_type

Financial Transaction Type Object

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

Tip
From CRM.COM R14.0.0 and onwards this information is only available if the voucher type classification is "Payment Voucher"

default_refund_method

Refund 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 only if the voucher type classification is Refund Voucher

Tip
Available from CRM.COM R14.0.0

log_information

Log Information Object

The log information of the retrieved voucher type

Set of Voucher Products Objects

The voucher type products that can consume the amount of money that will be paid by vouchers of this type

Anchor

	voucher type referred objects
	voucher type referred objects

Referred Objects Response Data

Include Page

	time_period_short
	time_period_short

Include Page

	financial_transaction_type_short
	financial_transaction_type_short

Include Page

	refund_method_short
	refund_method_short

Include Page

	log_information_short
	log_information_short

...