Skip to end of banner
Go to start of banner

reward_offer_segmentation_conditions

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 reward_offer_segmentation_condition object response data

Name

Type

Description

unitIntegerThe unit included in the reward offer's organisational unit condition
 segmentSegment objectThe segment included in the reward offer's segments condition

Referred Objects Response Data

Name

Type

Description

entity_nameStringThe name of the segmentation entity 
entity_idStringThe id of the segmentation entity 
entity_numberStringThe number of the segmentation entity, if applicable 
entity_alternative_codeStringThe alternative code of the segmentation entity, if applicable 
entity_descriptionStringThe 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
  • REFUNDS
  • REWARDAWARDTRANSACTIONS
  • REWARDPARTICIPANTS
  • REWARDSPENDTRANSACTIONS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • WRITEOFFS
  • SUBSCRIPTIONACTIONS
  • 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
  • Available from CRM.COM R12.0.0
  • LEADS is available from CRM.COM R15.0.0

Referred Objects Response Data

 segment_accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

name

String

The name of the retrieved accounts receivable

 segment_contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

name

String

The full name of the retrieved contact information

  • No labels