Versions Compared

Key

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

Available from CRM.COM R9.0.0

Excerpt

This method returns information related with to workflow rules having specific attributes. Multiple workflow rules are returned by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

entity

(mandatory)

String

The name of the entity related with to the workflow rules that should be returned as a result. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • CONTACTINFORMATION
  • CREDITNOTES

  • INVOICES
  • INVOICECANCELLATIONS
  • JOBS
  • LEADS
  • PAYMENTS
  • PAYMENTCANCELLATIONS
  • REFUNDS
  • REWARDOFFERS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • WALLETTRANSACTIONS
  • WRITEOFFS
Tip
  • REWARDOFFERS entity available from CRM.COM R11.0.0
  • LEADS entity available from CRM.COM R14.0.0
  • ACCOUNTSRECEIVABLE, CONTACTINFORMATION, CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, , WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R14R15.10.0

life_cycle_state

(optional)

StringThe life cycle state of the workflow rules that should be returned as a result. The supported options are EFFECTIVE or NOT EFFECTIVE. By default, all workflow rules are returned.

created_date

(optional)

Date The created date of the workflow rule that should be returned as a result.

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

...