Versions Compared

Old Version 3

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version Current

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

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


Tip

Available from CRM.COM R17.0.0


Excerpt

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

...

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:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

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

...

Expand
titleExample 1

HTTP Method: POST


Request

Body

javascript
Code Block
language
Code Block
{{server}}/crmapi/rest/v2/accounts_receivable/rewards/request_scheme_reference_code


Body

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


Response

language
Code Block
javascriptthemeConfluence
linenumberstrue
{
    "data": [],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}