Versions Compared

Old Version 2

changes.mady.by.user p_demou (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user p_demou (Deactivated)

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R10.1.0


Tip

Deprecated from CRM.COM R17.0.0


Excerpt

This method returns information related with the effective wallet which is related with a specific accounts receivable or rewards participant. A single wallet is returned by each call

Tip

Available from CRM.COM R10.1.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant identifier

The identifier of the rewards participant related with the effective wallet that should be retrieved as a result. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

accounts_receivable_identifier

(semi-optional)

Accounts Receivable identifier  

The identifier of the accounts receivable related with the effective wallet that should be retrieved as a result. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

Code Block
languagejs
themeConfluencelanguagejs
linenumberstrue
 {
    "token":"{{token}}",
    "accounts_receivable_identifier":{"number":"ACR0000000007"},
    "fields_set":"accounts_receivable,balance,currency,id,life_cycle_state,number"
}


Response:

Code Block
languagejs
  {
  "data": {
    "number": "W0000000026",
    "balance": 2919,
    "accounts_receivable": {
      "number": "ACR0000000007",
      "name": "ACR0000000007 Mary Keller",
      "id": "10A149D60365488AB53DCB889CFD98F8",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Mary Keller",
        "last_name": "Keller",
        "id": "64F72AE24DF644E6A9C2C21A3E397B67",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": "346346",
        "type": "PERSON",
        "first_name": "Mary",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "252365221",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "currency": {
      "suffix_symbol": null,
      "prefix_symbol": "£",
      "decimal_part_name": null,
      "code": "GBP",
      "integer_part_name": null,
      "id": "9"
    },
    "id": "A69C2273A76046F5AF90F3EC99824195",
    "life_cycle_state": "EFFECTIVE"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}


...