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
| ||
| 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, EXPIRED
| ||
| 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:
| ||
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 | ||
| 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"
| ||
| sold_by | 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"
| ||
| purchased_for | 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"
| ||
| invoice_type | Financial transaction type object | The type of Invoice to be created once an e-voucher is generated and the retailer or/and the customer will be debited. Available only if Voucher Type's Classification is equal to "Electronic Voucher"
| ||
| payment_type | Financial transaction type object | The type of Payment to be created once the e-voucher is used and a payment is submitted against the customer's accounts receivable. Available only if Voucher Type's Classification is equal to "Electronic Voucher"
| ||
| type | Voucher Type object | The type information of the retrieved voucher | ||
| lot | Vouchers Lot Object | The lot of the retrieved voucher
| ||
| payment | 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
| ||
| refund | Refund Object | The refund that created the voucher. This information becomes available only if the voucher was created due to a refund being posted
| ||
| log_information | Log Information Object | The log information of the retrieved voucher | ||
| products_set | 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 |
...