Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier

(mandatory)

Wallet identifier

The identifier of the wallet that should be returned as a result. The allowed wallets identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier
(semi-optional)

Accounts Receivable identifier

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

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

subscription_identifier

(semi-optional)

Subscription Identifier

The identifier of the subscription owned by the accounts receivable related with the wallets that should be returned as a result. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_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

...

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier

(mandatory)

Wallet identifier

The identifier of the wallet that should be returned as a result. The allowed wallets identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_identifier

wallet_transaction_type_identifier
(optional)

Wallet Transaction Type identifier

The wallet transactions type of the wallet transactions that should be retrieved in the results. The allowed wallet transaction type identifier fields are the following:

Include Page

	V4:wallet_transaction_type_identifier
	V4:wallet_transaction_type_identifier

number
(mandatory)

Number

The number of wallet transactions to be retrieved, starting from the latest one

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

...

This method is used to get the amount which is available for specific products for a specific period of time and a specific unit or group

Tip
Available from CRM.COM R5.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier

(mandatory)

Wallet identifier

The identifier of the wallet that should be returned as a result. The allowed wallets identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_identifier

product_identifier
(mandatory)

Product Identifier

The product for which the amount will be calculated for . The allowed product identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

unit_identifier

(semi-optional)

Unit identifier

The unit for which the amount will be calculated for. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

group_identifier

(semi-optional)

Group identifier

The group for which the amount will be calculated for. The allowed group identifier fields are the following:

Include Page

	V4:group_identifier
	V4:group_identifier

as_of_date

(mandatory)

Date field

The date for which the amount will be calculated for.

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

...

POST wallets/get_effective

Tip
Available from CRM.COM R10.1.0

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

...

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
	V4:rewards_participants_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier
(mandatory)

Account Receivable identifier

The identifier of the account receivable related with the wallet that should be created. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_identifier

udf_string_1
(optional)

String

User Defined Field of type String

udf_string_2
(optional)

String

User Defined Field of type String

udf_string_3
(optional)

String

User Defined Field of type String

udf_string_4
(optional)

String

User Defined Field of type String

udf_string_5
(optional)

String

User Defined Field of type String

udf_string_6
(optional)

String

User Defined Field of type String

udf_string_7
(optional)

String

User Defined Field of type String

udf_string_8
(optional)

String

User Defined Field of type String

udf_float_1
(optional)

Float

User Defined Field of type Float

udf_float_2
(optional)

Float

User Defined Field of type Float

udf_float_3
(optional)

Float

User Defined Field of type Float

udf_float_4
(optional)

Float

User Defined Field of type Float

udf_date_1
(optional)

Date

User Defined Field of type Date

udf_date_2
(optional)

Date

User Defined Field of type Date

udf_date_3
(optional)

Date

User Defined Field of type Date

udf_date_4
(optional)

Date

User Defined Field of type Date

product_consumption_set

(optional)

Set of Wallet Product Consumption Objects

The information related with the consumption of the wallet amount by various products

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

...

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier
(mandatory)

Wallet Identifier

The identifier of the wallet to be updated. The allowed wallet identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_identifier

udf_string_1
(optional)

String

User Defined Field of type String

udf_string_2
(optional)

String

User Defined Field of type String

udf_string_3
(optional)

String

User Defined Field of type String

udf_string_4
(optional)

String

User Defined Field of type String

udf_string_5
(optional)

String

User Defined Field of type String

udf_string_6
(optional)

String

User Defined Field of type String

udf_string_7
(optional)

String

User Defined Field of type String

udf_string_8
(optional)

String

User Defined Field of type String

udf_float_1
(optional)

Float

User Defined Field of type Float

udf_float_2
(optional)

Float

User Defined Field of type Float

udf_float_3
(optional)

Float

User Defined Field of type Float

udf_float_4
(optional)

Float

User Defined Field of type Float

udf_date_1
(optional)

Date

User Defined Field of type Date

udf_date_2
(optional)

Date

User Defined Field of type Date

udf_date_3
(optional)

Date

User Defined Field of type Date

udf_date_4
(optional)

Date

User Defined Field of type Date

product_consumption_set

Set of Wallet Consumption Objects

The information related with the consumption of the wallet amount by various products

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

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

...

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier

(mandatory)

Wallet identifier

The identifier of the wallet that should be cancelled. The allowed wallet identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_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

...

POST wallets/get_expiring_balance

Tip
Available from CRM.COM R10.1.0

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

...

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
	V4:rewards_participants_identifier

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

...

POST wallets/get_balance

Tip
Available from CRM.COM R12.0.0

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
	V4:rewards_participants_identifier

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

  {
    "token":"D3D8429F9C90424C8898D5776EFDDC68",
    "wallet_identifier":{"number":"W0000000682"},
    "as_of_date":"2017-01-08T14:00:59"
   
}

Response:

Code Block

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": ""
  }
}

GET wallets/transactions/get_current_balance_period_transactions

Tip
Available from CRM.COM R12.0.0

This method is used to get the detailed information of a wallet's running and opening balance, as well as of the wallet amounts which were not considered during the latest wallet opening balance calculation. The opening balance wallet transactions which are not related to any wallet balance period and as a result, their amounts are not included in the opening balance of the wallet for the currently open wallet balance period. Wallet transactions of a single wallet can be retrieved by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier

(mandatory)

Wallet Identifier

The identifier of the wallet that should be returned as a result. The allowed wallets identifier fields are the following:

Include Page

	V4:wallet_identifier
	V4:wallet_identifier

number
(optional)

Number

The number of wallet transactions to be retrieved, starting from the latest one

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

...

Response Data

Include Page

	V4:wallet_allotments_per_balance_period_transaction_short
	V4:wallet_allotments_per_balance_periodtransaction_short

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

Response:

Code Block

...

Versions Compared

Old Version 65

New Version 66

Key

Resource URL

Parameters

POST wallets/get_effective

POST wallets/get_expiring_balance

POST wallets/get_balance

GET wallets/transactions/get_current_balance_period_transactions

Response Data

Examples

Page Comparison

Versions Compared

Old Version 65

New Version 66

Key

Resource URL

Parameters

POST wallets/get_effective

POST wallets/get_expiring_balance

POST wallets/get_balance

GET wallets/transactions/get_current_balance_period_transactions

Response Data

Examples