Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

voucher voucherThe life cycle state of the retrieved voucher which can be DRAFT, ACCEPTED_FOR_ACTIVATION, NOT_ACCEPTED_FOR_ACTIVATION, ACTIVATED, USED, CANCELLED, PURGED

Name

Type

Description

idStringThe ID of the retrieved notification
numberStringThe number of the retrieved notification
alternativelife_cycle_codestateStringThe alternative code of the retrieved voucher
descriptionStringThe description of the retrieved voucher
valueNumberThe value of the retrieved voucher
extra_added_valueNumberThe extra added value of the retrieved voucher
effective_dateDateThe date that the voucher becomes effectivelife cycle state of the retrieved notification which can be PENDING, REJECTED or COMPLETED and is calculated dynamically based on the related communication queue entry life cycle state
total_notified_amountNumber

Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total initial notified amount for each subscription or job or bill included in the notification

total_outstanding_amountNumberAdditional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total  amount which is still outstanding for each subscription or bill or job included in the notification
unsettled_amountNumberAdditional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
expiration_dateDate

The

date that the voucher expires

life_cycle_state

String

expiration date of the notification as provided through the Notification Type

Tip

Available from R14.2.0

upcoming_bill_amountNumber

Additional information which is populated if the notification type is classified as financial and if the notified information is set to Bills, having the "Calculate upcoming bill" option enabled. It defines the total upcoming bill amount to be paid of each accounts receivable included in the notification

Tip

Available from R14.5.0

 upcoming_bill_as_of_date Date

 The as of date of the upcoming bill calculated

Tip

Available from R14.5.0

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 Notification Type objectThe type information of the retrieved voucher
lotVouchers Lot ObjectThe lot of the retrieved voucher
paymentPayment ObjectThe payment that was created and posted as a result of using the voucher. This information becomes available only if the voucher is used.of the specific notification
notification_runNotification Run object

The notification run that generated the specific notification

contact_informationContact Information objectThe contact information related with the specific notification
accounts_receivable

Accounts Receivable object

The accounts receivable related with the specific notification
communication_queueCommunication Queue ObjectThe communication queue entry that was created for the specific notification
currency_rate_periodCurrency Rate Period ObjectThe notification's currency rate period

log_information

Log Information Object

The log information

of

related with the retrieved

voucher

notification

productsitems_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

...

Notification Item objectsThe information for which the customer will be notified about by the specific notification. That information differentiates based on the notification type classification

Anchor
notification objects
notification objects
Referred Objects Response Data

Include Page
vouchernotification_type_shortvoucher
notification_type_short

Include Page
notification_run_short
notification_run_short

Include Page
contact_information_short
contact_information_short

Include Page
lotaccounts_receivable_shortlot
accounts_receivable_short

Include Page
paymentcommunication_queue_shortpayment
communication_queue_short

Include Page
logcurrency_rate_informationperiod_shortlog
currency_rate_informationperiod_short

Include Page
voucherlog_productinformation_shortvoucher
log_productinformation_short

Include Page
unitnotification_item_shortunit
notification_item_short