Page Comparison

...

Tip
Available from CRM.COM R10.1.0

Excerpt
This method returns information related with the wallet balance that expires before a specified threshold date. The expiring balance of a single wallet can be retrieved 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

wallet_identifier

(semi-optional)

Wallet Identifier

The identifier of the wallet that should be returned in the results. The allowed wallet identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant owning the wallet that should be returned in the results. The allowed rewards participant identifier fields are the following:

Include Page

	V4:rewards_participants_identifier_post
	V4:rewards_participants_identifier_post

Tip
Deprecated from CRM.COM R17.0.0

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable owning the wallet that should be returned in the results. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

threshold_date

(mandatory)

Date

The expiration period in days. Only wallet balance that expires on a date which is equal or before the threshold date will be retrieved

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

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

{
  "token":"101F9468E78B4CDB91716A60D3DFC5C8",
  "wallet_identifier":{"number":"W0000000755"},
  "threshold_date":"2016-10-30T14:00:59"
}

Response:

Code Block

language	js

     {
        "data":
        {
            "balance": 38,
            "expired_amount": 18,
            "remaining_amount": 20,
            "currency":
            {
                "suffix_symbol": "N/A",
                "prefix_symbol": "\u20ac",
                "decimal_part_name": "cents",
                "code": "EUR",
                "integer_part_name": "euro",
                "id": "2"
            }
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Restrictions