Page Comparison

...

Tip
Available from CRM.COM R12.0.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.

Tip
Available from CRM.COM R12.0.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

accounts

_

receivable_identifier

(semi-optional)

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)

Date

The 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

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":"D3D8429F9C90424C8898D5776EFDDC68",
    "wallet_identifier":{"number":"W0000000682"},
    "as_of_date":"2017-01-08T14:00:59"
   
}

Response:

Code Block

language	js
theme	Confluence
language	js
linenumbers	true

 {
  "data": {
    "balance": 6,
    "allotment_group_conditions_set": [
      {
        "time_conditions_set": [],
        "date_conditions_set": [],
        "unit_conditions_set": [],
        "total_amount": 0,
        "product_conditions_set": [],
        "id": "1858C790DD4E4999916D6C0BF63D8A8B",
        "number_of_conditions": 0
      },
      {
        "time_conditions_set": [],
        "date_conditions_set": [
          {
            "id": "9C9CE920101F4C34B48D0EAE5ACD03D1",
            "day_of_week": "THURSDAY"
          },
          {
            "id": "55D0E56851034822999DDB64621DC629",
            "day_of_week": "FRIDAY"
          },
          {
            "id": "FEC879A4EA584CD7B96E5D405869407E",
            "day_of_week": "SATURDAY"
          },
          {
            "id": "B3B4054B5D7744E4BA95D388CAD187A2",
            "day_of_week": "MONDAY"
          },
          {
            "id": "F769CB3077584ECFBE1822276DF864C7",
            "day_of_week": "SUNDAY"
          },
          {
            "id": "43C9C18B243740F6B4E3F0EBDABC72F1",
            "day_of_week": "WEDNESDAY"
          },
          {
            "id": "E90EA057542D47008495E1E12E21F1B7",
            "day_of_week": "TUESDAY"
          }
        ],
        "unit_conditions_set": [
          {
            "unit": null,
            "id": "7FB26506F6A54544B774F76164B45E42",
            "group": {
              "alternative_code": "A",
              "community_name": "Internal",
              "name": "Addidas",
              "description": "Addidas",
              "id": "FE1585AE3D954CC4AB956DB656FA847C"
            }
          }
        ],
        "total_amount": 3,
        "product_conditions_set": [
          {
            "product_family": null,
            "product": {
              "code": "Serendipity",
              "product_type": {
                "service_type": "USAGE",
                "used_for_provisioning": true,
                "alternative_code": "V",
                "composition_method": "FLAT",
                "name": "Usage Services",
                "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
                "id": "751C638AA3534B768408AAC4D73CF516",
                "classification": "SERVICES",
                "physical_good_type": null
              },
              "alternative_code": "S_1",
              "description": "VOD: Serendipity ",
              "id": "BD3ACEE7D6244DCAA375D0744DA75540"
            },
            "product_type": null,
            "id": "EF79FF61BB074D6D841354FA3264B8F9"
          }
        ],
        "id": "3B180ADA495B48D6A2F64373113EE5EB",
        "number_of_conditions": 9
      },
      {
        "time_conditions_set": [],
        "date_conditions_set": [
          {
            "id": "00AF0669BE14410B965F04C80A973B33",
            "day_of_week": "WEDNESDAY"
          },
          {
            "id": "8C8A05A8A5F24356A93AA18291CAFA89",
            "day_of_week": "SUNDAY"
          },
          {
            "id": "482E65AB09A8425A99FCD5714EDB14B5",
            "day_of_week": "MONDAY"
          },
          {
            "id": "5A11FE46247A404D993D96300A73B78B",
            "day_of_week": "THURSDAY"
          },
          {
            "id": "38C8FF27FA4942B2935FB160A0BA63C9",
            "day_of_week": "FRIDAY"
          },
          {
            "id": "9BE4EA94DF204524A3A0698A9C49F316",
            "day_of_week": "SATURDAY"
          },
          {
            "id": "18F4EDD786E6488FA224795958C0B58D",
            "day_of_week": "TUESDAY"
          }
        ],
        "unit_conditions_set": [
          {
            "unit": null,
            "id": "6DC0174C7B9D4D239AC7FAD36374953E",
            "group": {
              "alternative_code": "A",
              "community_name": "Internal",
              "name": "Addidas",
              "description": "Addidas",
              "id": "FE1585AE3D954CC4AB956DB656FA847C"
            }
          }
        ],
        "total_amount": 3,
        "product_conditions_set": [],
        "id": "F72E65638747455D96A97D67980D05B9",
        "number_of_conditions": 8
      }
    ],
    "currency": {
      "suffix_symbol": "N/A",
      "prefix_symbol": "€",
      "decimal_part_name": "cents",
      "code": "EUR",
      "integer_part_name": "euro",
      "id": "2"
    },
    "id": "46B9514E05F140C5B2193BEF103D1FD1"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
linenumbers	true

{
   "token":"{{token}}",
   "wallet_identifier": {"number":"W0000007300"}
}

Response:

Code Block

language	js
theme	Confluence
linenumbers	true

 {
    "data": {
        "balance": -9,
        "allotment_group_conditions_set": [
            {
                "time_conditions_set": [],
                "opening_balance_date": null,
                "date_conditions_set": [],
                "wallet_balance_period": null,
                "unit_conditions_set": [],
                "total_amount": -9,
                "product_conditions_set": [],
                "allotment_group_opening_alternative_balance": null,
                "id": "879B340466054CA4A2934CF9CD8D481B",
                "number_of_conditions": 0,
                "total_alternative_amount": 0,
                "allotment_group_opening_balance": null
            }
        ],
        "currency": {
            "suffix_symbol": null,
            "prefix_symbol": "€",
            "decimal_part_name": null,
            "code": "EUR",
            "integer_part_name": null,
            "id": "2",
            "life_cycle_state": "EFFECTIVE"
        },
        "alternative_currency": null,
        "id": "53B5742198524FEBBB3A2BD713CD79B8",
        "remaining_wallet_transaction_limits": {
            "remaining_annual_limit": 768,
            "remaining_daily_limit": 25
        },
        "alternative_balance": 0
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
linenumbers	true

{
   "token":"{{token}}",
    "wallet_identifier": {"number":"W0000000226"}
}

Response:

Code Block

language	js
theme	Confluence
linenumbers	true

 {
    "data": {
        "balance": 0,
        "allotment_group_conditions_set": [
            {
                "time_conditions_set": [],
                "opening_balance_date": null,
                "date_conditions_set": [],
                "wallet_balance_period": null,
                "unit_conditions_set": [],
                "total_amount": 0,
                "product_conditions_set": [],
                "allotment_group_opening_alternative_balance": null,
                "id": "061860F96DAA418D818D3B02AA449F66",
                "number_of_conditions": 0,
                "total_alternative_amount": 0,
                "allotment_group_opening_balance": null
            }
        ],
        "currency": {
            "suffix_symbol": null,
            "prefix_symbol": "£",
            "decimal_part_name": null,
            "code": "GBP",
            "integer_part_name": null,
            "id": "9",
            "life_cycle_state": "EFFECTIVE"
        },
        "alternative_currency": null,
        "id": "318EA4E95FD349C7B9386C71A8F71D35",
        "remaining_wallet_transaction_limits": {
            "remaining_annual_limit": 1680,
            "remaining_daily_limit": 42
        },
        "alternative_balance": 0
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Restrictions