Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the workflow rule

name

String

The name of the workflow rule

life_cycle_stateString

The life cycle state of the workflow rule which can be EFFECTIVE or NOT EFFECTIVE

descriptionStringThe description of theĀ  workflow rule
processing_orderStringThe Processing order of the workflow rule which can be ACTIONS THEN UPDATES, UPDATES THEN ACTIONS
priorityStringThe Workflow Rule's Priority which can be LOW, MEDIUM, HIGH
entityString

The name of the entity with which the workflow rule is related to. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • CONTACTINFORMATIONFINANCIALTRANSACTIONS
  • CREDIT_NOTE

  • INVOICE

  • INVOICE_CANCELLATION

  • JOBS

  • LEADS
  • PAYMENT
  • PAYMENT_CANCELLATION
  • REFUND
  • REWARDOFFERS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • WALLETTRANSACTIONS
  • WRITE_OFF
Tip
  • REWARDOFFERS entity available from CRM.COM R11.0.0
  • LEADS entity available from CRM.COM R14.0.0
  • ACCOUNTSRECEIVABLE, CONTACTINFORMATION, FINANCIALTRANSACTIONSCREDIT_NOTE, INVOICE, INVOICE_CANCELLATION, PAYMENT, PAYMENT_CANCELLATION, REFUND, WRITE_OFF, WALLETS, WALLETTRANSACTIONS are available from CRM.COM R14.1.0
entity_typesEntity Type ObjectThe Entity Types which are applicable for the workflow rule.
log_information

Log Information Object

The log information related with the retrieved workflow rule

...