Versions Compared

Key

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

Name

Type

Description

entity_name StringStringThe name of the segmentation entity 
entity_id StringStringThe id of the segmentation entity 
entity_number StringStringThe number of the segmentation entity, if applicable 
entity_alternative_code StringStringThe alternative code of the segmentation entity, if applicable 
entity_description StringStringThe 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:

  • BILLS
  • BUYINADVANCEREQUESTS
  • CREDITNOTES
  • INVOICES
  • INVOICECANCELLATIONS
  • JOBS
  • PAYMENTS
  • PAYMENTCANCELLATIONS
  • PAYMENTGATEWAYCARDS
  • PAYMENTGATEWAYREQUESTS
  • REWARDSPENDTRANSACTIONSREFUNDS
  • REWARDAWARDTRANSACTIONS
  • REWARDPARTICIPANTS
  • REWARDSPENDTRANSACTIONS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • WRITEOFFS
  • BUYINADVANCEREQUESTSSUBSCRIPTIONACTIONS
Tip
  • Available from CRM.COM R12.0.0
  • SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0
  • CREDITNOTES, INVOICES, INVOICECANCELLATIONS, REFUNDS, PAYMENTCANCELLATIONS, WALLETS, WRITEOFFS are available from CRM.COM R15.0.0


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:

  • ACTIVITIES
 
  • LEADS
Tip
  • Available from CRM.COM R12.0.0
  • LEADS is available from CRM.COM R15.0.0

Anchor
segment referred objects
segment referred objects
Referred Objects Response Data

...