Versions Compared

Key

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


Tip

Available from CRM.COM R14.2.0


Excerpt

This method returns information related with the balance of the wallet which is available either on the current date or as of a date in the future. The balance of a single wallet can be retrieved by each call.

...

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

as_of_date

(optional)

DateThe date as of which the wallet balance will be calculated (inclusive). If specified then this date should be in the future. If not specified then the current date is used

no_allotments_included

(optional)

Boolean

If set to TRUE then the allotment group information retrieved within the balance breakdown sets, will not be retrieved.

Tip

Available from CRM.COM R14.17.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

...