POST accounts_receivable/rewards/request_scheme_reference_code

Available from CRM.COM R17.0.0

This method generates and returns a reference code that can be used to sign an accounts receivable into a specific rewards scheme

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

email_address

(mandatory)

String

The business email address that should be validated against the reward scheme' supported domains

accounts_receivable_identifier

(mandatory)

Accounts Receivable Identifier

The identifier of the participant's accounts receivable that will use the reference code. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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

Response Data

N/A

Examples

Example 1

HTTP Method: POST

Request

{{server}}/crmapi/rest/v2/accounts_receivable/rewards/request_scheme_reference_code

Body

{
   "token":"{{token}}",
     "accounts_receivable_identifier": {"id":"5274C9686C2940C5A9A2F399C01BEE80"},    
     "email_address":"e_tzirtzipi@crm.com"
}

Response

{
    "data": [],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}