Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the retrieved segment

number

String

The number of the retrieved segment

alternative_codeStringThe alternative code of the retrieved segment

life_cycle_state

String

The life cycle state of the retrieved segment which can be DRAFT or POSTED

criteriaStringThe segmentation criteria of the retrieved segment
entityString

The entity of the retrieved segment which can be one of the following

  • ACCOUNTS_RECEIVABLE

    ACCOUNTSRECEIVABLE

  • ACTIVITIES

  • BILLS

    CONTACT_INFORMATION

  • BUYINADVANCEREQUESTS

  • CONTACTINFORMATION

  • CREDITNOTES
  • FINANCIALTRANSACTIONS
  • INVOICES
  • INVOICECANCELLATIONS
  • JOBS

  • LEADS
  • PAYMENTGATEWAYCARDS

  • PAYMENTGATEWAYREQUESTS

  • PAYMENTS

  • PAYMENT_GATEWAY_CARDS
  • PAYMENT_GATEWAY_REQUESTS
  • AWARD_REWARD_TRANSACTIONS
  • SPEND_REWARD_TRANSACTIONS
  • REWARDS_PARTICIPANTS
  • SERVICE_REQUESTS
  • SUBSCRIPTIONS
  • BUYINADVANCEREQUESTS

  • PAYMENTCANCELLATIONS
  • REFUNDS
  • REWARDAWARDTRANSACTIONS

  • REWARDOFFERS
  • REWARDPARTICIPANTS

  • REWARDSPENDTRANSACTIONS

  • SERVICEREQUESTS

  • SUBSCRIPTIONS

  • WALLETS
  • WALLETTRANSACTIONS
  • WRITEOFFS
  • SUBSCRIPTIONACTIONS
Tip

SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0

CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0

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

exceptional_itemsExceptional items objectThe exceptional items of the retrieved segment
log_informationLog Information ObjectThe log information of the retrieved segment

...