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

descriptionStringThe description of the retrieved voucher
valueNumberThe value of the retrieved voucher
extra_added_valueNumber

The extra added value of the retrieved voucher

Tip

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

effective_dateDateThe date that the voucher becomes effective
expiration_dateDateThe 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

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

typeVoucher Type objectThe type information of the retrieved voucher
lotVouchers Lot Object

The lot of the retrieved voucher

Tip

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

paymentPayment 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 R14.0.0 and onwards this information is available only if the voucher type classification is "Payment Voucher"

log_informationLog Information ObjectThe log information of the retrieved voucher
products_setSet of Voucher Products ObjectsThe voucher products that can consume the amount of money that was paid through the voucher
allowed_organisational_units_setSet of unit ObjectsThe organisational units that can use the specific voucher type

...