Versions Compared

Key

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

Name

Type

Description

entity_name StringThe name of the segmentation entity 
entity_id StringThe id of the segmentation entity 
entity_number StringThe number of the segmentation entity, if applicable 
entity_alternative_code StringThe alternative code of the segmentation entity, if applicable 
entity_description StringThe description of the segmentation entity, if applicable 
accounts_receivableAccounts Receivable Object

The Accounts Receivable of the segmented entity. Applicable only for Accounts Receivable-based entities and in cases in which the segment's entity is one of the following:

  • Subscriptions
  • Buy In Advance Requests
  • Jobs
  • Service Requests
  • Payments
  • Payment Gateway Cards
  • Payment Gateway Requests
  • Bills
  • Rewards Participants
  • Award Transactions
  • Spend Transactions
  • Award Expiration TransactionsBILLS
  • CONTACTINFORMATION
  • JOBS
  • PAYMENTS
  • PAYMENTGATEWAYCARDS
  • PAYMENTGATEWAYREQUESTS
  • REWARDSPENDTRANSACTIONS
  • REWARDAWARDTRANSACTIONS
  • REWARDPARTICIPANTS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • BUYINADVANCEREQUESTS
contact_informationContact Information Object

The Contact Information of the segmented entity. Applicable only for Contact Information-based entities and in cases in which the segment's entity is one of the following:

  • ActivitiesACTIVITIES

Anchor
segment referred objects
segment referred objects
Referred Objects Response Data

...