Versions Compared

Old Version 5

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user George Rossides

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlevoucher _type response data object

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_valueNumber

The extra added value of the retrieved voucher

Tip

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

Tip

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

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"

 

Anchor
voucher referred objects
voucher referred objects
Referred Objects Response Data

Include Page
voucher_type_short
voucher_type_short

Include Page
lot_short
lot_short