Versions Compared

Key

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

This method returns information related with a segmentation.  Multiple communications are returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

entity

(mandatory)

String

The entity of the segments to be retrieved which can be

  • ACCOUNTSRECEIVABLE

  • ACTIVITIES

  • BILLS

  • BUYINADVANCEREQUESTS

  • CONTACTINFORMATION

  • CREDITNOTES
  • FINANCIALTRANSACTIONS
  • INVOICES
  • INVOICECANCELLATIONS
  • JOBS

  • LEADS
  • PAYMENTGATEWAYCARDS

  • PAYMENTGATEWAYREQUESTS

  • PAYMENTS

  • PAYMENTCANCELLATIONS
  • REFUNDS
  • REWARDAWARDTRANSACTIONS

  • REWARDOFFERS
  • REWARDPARTICIPANTS

  • REWARDSPENDTRANSACTIONS

  • SERVICEREQUESTS

  • SUBSCRIPTIONS

  • WALLETS
  • WALLETTRANSACTIONS
  • WRITEOFFS
Tip

FINANCIALTRANSACTIONSCREDITNOTES, INVOICES, INVOICECANCELLATIONS, LEADS, PAYMENTCANCELLATIONS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R14.1.0

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...