Skip to end of banner
Go to start of banner

voucher_short

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Name

Type

Description

id

String

The ID of the retrieved voucher

number

String

The number of the retrieved voucher

alternative_codeStringThe alternative code of the retrieved voucher
valueNumberThe value of the retrieved voucher
extra_added_valueNumberThe extra added value of the retrieved voucher

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

typeVoucher Type objectThe type information of the retrieved voucher
lotVouchers Lot ObjectThe lot of the retrieved voucher

 

Referred Objects Response Data

 voucher_type response data object
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
value_optionsString

Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE

From CRM.COM R13.1.0 and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE

From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE

classificationString

The Classification of the retrieved voucher type

Available from CRM.COM R13.1.0

descriptionStringThe Description of the retrieved voucher type

 lot response data object
NameType Description
IdStringThe ID of the retrieved lot
numberStringThe number of the retrieved lot
alternative_codeStringThe alternative code of the retrieved lot
descriptionStringThe description of the retrieved lot

  • No labels