voucher_short
Former user (Deleted)
George Rossides (Unlicensed)
Joseph Ioannou (Unlicensed)
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved voucher |
number | String | The number of the retrieved voucher |
| value | Number | The value of the retrieved voucher |
| extra_added_value | Number | The extra added value of the retrieved voucher From CRM.COM R14.0.0 and onwards this information is only available if the voucher type classification is "Payment 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 From CRM.COM R14.0.0 and onwards the applicable life cycle state of the retrieved voucher of type with classification "Refund Voucher" can be ACTIVATED, USED, PURGED |
| type | Voucher Type object | The type information of the retrieved voucher |
| lot | Vouchers Lot Object | The lot of the retrieved voucher From CRM.COM R14.0.0 and onwards this information is available only if the voucher type classification is "Payment Voucher" |
Referred Objects Response Data
| 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 |
| value_options | String | 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 |
| classification | String | The Classification of the retrieved voucher type Available from CRM.COM R13.1.0 |
| description | String | The Description of the retrieved voucher type |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved lot |
| number | String | The number of the retrieved lot |
| alternative_code | String | The alternative code of the retrieved lot |
| description | String | The description of the retrieved lot |