Name | Type | Description | ||
---|---|---|---|---|
id | String | The ID of the retrieved notification | ||
number | String | The number of the retrieved notification | ||
life_cycle_state | String | The life 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_amount | Number | 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_amount | Number | 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 amount which is still outstanding for each subscription or bill or job included in the notification | ||
unsettled_amount | Number | 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 amount which is still unsettled for each subscription or bill or job included in the notification | ||
expiration_date | Date | The expiration date of the notification as provided through the Notification Type
| ||
upcoming_bill_amount | Number | 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
| ||
upcoming_bill_as_of_date | Date | The as of date of the upcoming bill calculated
| ||
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 | ||
type | Notification Type object | The type of the specific notification | ||
notification_run | Notification Run object | The notification run that generated the specific notification Tip | | |
contact_information | Contact Information object | The contact information related with the specific notification | ||
accounts_receivable | Accounts Receivable object | The accounts receivable related with the specific notification | ||
communication_queue | Communication Queue Object | The communication queue entry that was created for the specific notification | ||
currency_rate_period | Currency Rate Period Object | The notification's currency rate period | ||
Log Information Object | The log information related with the retrieved notification | |||
items_set | Set of Notification Item objects | The information for which the customer will be notified about by the specific notification. That information differentiates based on the notification type classification |
...