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

number

String

The number of the retrieved voucher

description

String

The description of the retrieved voucher

value

Number

The value of the retrieved voucher

extra_added_value

Number

The extra added value of the retrieved voucher

Tip
From CRM.COM R13.1.0 and onwards this information is available only if the voucher type classification is "Printed Payment Voucher" with value option set to Fixed OR type classification is "Electronic Payment Voucher" and value options is other set to Fixed or Variable

effective_date

Date

The date that the voucher becomes effective

expiration_date

Date

The date that the voucher expires

life_cycle_state

String

The life cycle state of the retrieved voucher which can be DRAFT, ACCEPTED_FOR_ACTIVATION, NOT_ACCEPTED_FOR_ACTIVATION, ACTIVATED, USED, CANCELLED, PURGED

Tip

From CRM.COM R13.1.0 and onwards the applicable life cycle state of the retrieved voucher of a type with classification "Electronic Voucher" can be ACTIVATED, USED, CANCELLED

From CRM.COM R15.0.0 and onwards the PURGED life cycle state will also be avialable for Electronic vouchers

From CRM.COM R14.0.0 and onwards the applicable life cycle state of the retrieved voucher of a type with classification "Refund Voucher" can be ACTIVATED, USED, PURGED

cancellation_reason

String

The cancellation reason of the retrieved voucher. Available only if Voucher Type's Classification is equal to "Electronic Voucher" and it's life cycle state is set to CANCELLED. Applicable values:

- VOUCHER_RETURN
- VOUCHER_LOSS
- VOUCHER_FRAUD

Tip
From CRM.COM R13.1.0 and onwards

Tip
From CRM.COM R15.0.0 cancellation reasons will also applicable for Printed payment vouchers (all except VOUCHER_RETURN)

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

Voucher Type object

The type information of the retrieved voucher

Voucher Type Classification

The classification purchased_by

Accounts Receivable Object

The Accounts Receivable of the Customer who bought the e-voucher. Available only if Voucher Type's Classification is equal to "Electronic Voucher"

Tip
Available from CRM.COM R13.1.0

Accounts Receivable Object

The Accounts Receivable of the Retailer who sold the e-voucher. Available only if Voucher Type's Classification is equal to "Electronic Voucher"

Tip
Available from CRM.COM R13.1.0

Accounts Receivable Object

The Accounts Receivable of the Customer for whom the e-voucher was bought for. Available only if Voucher Type's Classification is equal to "Electronic Voucher"

Tip
Available from CRM.COM R13.1.0

Voucher Type object

The voucher type information of the retrieved voucher

Vouchers Lot Object

The lot of the retrieved voucher. Applicable only for Printed vouchers generated within CRM.COM

Payment Object

The payment that was created and posted as a result of using the voucher. This information becomes available only if the voucher is used

Tip
From CRM.COM R13.1.0* and onwards this information is available only if the voucher type classification is "Payment Voucher" or "Electronic Voucher"*

Refund Object

The refund that created the voucher. This information becomes available only if the voucher was created due to a refund being posted

Tip
Available from CRM.COM R14.0.0

log_information

Log Information Object

The log information of the retrieved voucher

Currency Object

The voucher's currency

Tip
Available from CRM.COM R14.2.0

Set of Voucher Products Objects

The voucher products that can consume the amount of money that was paid through the voucher

allowed_organisational_units_set

Set of unit Objects

The organisational units that can use the specific voucher type

Tip
Deprecated from CRM.COM R13.1.0 onwards

Anchor

	voucher referred objects
	voucher referred objects

Referred Objects Response Data

Include Page

	voucher_type_short
	voucher_type_short

Include Page

	voucher_type_classification_complete	voucher_type_classification_completelot_short
	lot_short

Include Page

	lotpayment_shortlot
	payment_short

Include Page

	paymentrefund_shortpayment
	refund_short

Include Page

	log_information_short
	log_information_short

Include Page

	currency_short
	currency_short

Include Page

	voucher_product_short
	voucher_product_short

Include Page

	unit_short
	unit_short

Include Page

	accounts_receivable_short
	accounts_receivable_short

Include Page

	financial_transaction_type_short
	financial_transaction_type_short