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 approval requests having specific attributes. Multiple approval requests are returned by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

authorised_user_identifier
(semi-optional)
User IdentifierThe identifier of the authorised user related with the approval requests that should be returned as a result. The allowed user identifier fields are the following:

Include Page
V4:user_identifier
V4:user_identifier

approval_definition_identifier

(semi-optional)

Approval Definition IdentifierThe identifier of the approval definition related with the approval requests that should be returned as a result. The allowed approval definition identifier fields are the following:

Include Page
V4:approval_definition_identifier
V4:approval_definition_identifier

workflow_rule_identifier

(semi-optional)

Workflow Rule IdentifierThe identifier of the workflow rule that triggered the approval requests that should be returned as a result. The allowed workflow rule identifier fields are the following:

Include Page
V4:workflow_rule_identifier
V4:workflow_rule_identifier

entity

(semi-optional)

String

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

  • ACTIVITIES
  • CREDITNOTES

  • INVOICES

  • JOBS

  • LEADS
  • PAYMENTS
  • REFUNDS
  • REWARDOFFERS
  • SERVICEREQUESTS
  • SUBSCRIPTIONSWRITEOFFS
Tip
  • REWARDOFFERS entity is available from CRM.COM R11.0.0
  • LEADS entity is available from CRM.COM R14.0.0
  • CREDITNOTES, INVOICES, PAYMENTS, REFUNDS , WRITEOFFS are available from CRM.COM R14.1.0

entity_id

(semi-optional)

StringThe ID of the entity related with the approval requests that should be returned as a result

responded_by_user_identifier

(optional)

User IdentifierThe identifier of the responded by user related with the approval requests that should be returned as a result. The allowed user identifier fields are the following:

Include Page
V4:user_identifier
V4:user_identifier

unified_code

(optional)

String The unified code of the approval requests that should be returned as a result

life_cycle_state

(optional)

StringThe life cycle state of the approval requests that should be returned as a result. The supported options are PENDING, ACCEPTED, REJECTED or CANCELLED

created_date

(optional)

Date The created date of the approval requests that should be returned as a result.

response_date

(optional)

Date The response date of the approval requests 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

...