Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlenotification item response data

Name

Type

Description

id

String

The ID of the retrieved notification item

entity_name

String

The entity name of the retrieved notification which can be SUBSCRIPTIONS, JOBS, BILLS, WALLETS, WALLET_PRODUCT_CONSUMPTION, JOBS OR ACTIVITIES one of the following:

  • ACTIVITIES
  • BILLS
  • JOBS
  • LEADS
  • PAYMENTS
  • PAYMENT_GATEWAY_CARDS
  • PAYMENT_GATEWAY_REQUESTS
  • AWARD_REWARD_TRANSACTIONS
  • SPEND_REWARD_TRANSACTIONS
  • REWARDS_PARTICIPANT
  • SERVICE_REQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • WALLET_PRODUCT_CONSUMPTION
  • BUY_IN_ADVANCE_REQUESTS
  • REWARD_OFFERS
  • SUBSCRIPTION_ACTIONS

Tip

REWARD_OFFERS entity name available from CRM.COM R12.0.0

SUBSCRIPTION_ACTIONS entity name is available from CRM.COM R14.2.0


entity_value

String

The primary key value of the notification item
notified_amountNumber

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

outstanding_amountNumberAdditional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or 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 or Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
estimated_consumption_daysNumberAdditional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption.It defines the number of remaining days, as of the date of the notification
estimated_consumption_dateDateAdditional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption. It defines the estimated consumption date, as of the date of the notification
expiration_amountNumber

Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the amount that is about to be expired up to a specific date set in the notification's related run definition

Tip

Available from CRM.COM R11.1.0

expiration_dateDate

Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the date that the expiration amount will expire.

Tip

Available from CRM.COM R11.1.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 entity (Subscription or Job) included in the notification

Tip

Available from R14.5.0