Versions Compared

Key

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


Name

Type

Description

id

String

The ID of the retrieved wallet

number

String

The number of the retrieved wallet

estimated_consumption_daysNumberAn estimation on the number of days left until the whole wallet amount will be consumed
estimated_consumption_dateDateAn estimation of the date on which the whole wallet amount will be consumed
estimated_consumption_as_of_dateDateThe latest date that the estimation was performed
balanceNumberThe balance of the retrieved wallet in wallet currency
alternative_balanceNumber

The balance of the retrieved wallet in wallet alternative currency

Tip

Available from CRM.COM R14.2.0


opening_balanceNumber

The opening balance of the wallet - in wallet currency - as this was calculated for the latest and still Open Wallet Balance Period. This information is calculated during the latest Wallet Balance per Period process

Tip

Available from CRM.COM R12.1.0


opening_alternative_balanceNumber

The opening balance of the wallet in the alternative currency, as this was calculated for the latest and still Open Wallet Balance Period. This information is calculated during the latest Wallet Balance per Period process

Tip

Available from CRM.COM R14.2.0


opening_balance_dateDate

The date on which the wallet's opening balance was last updated.

Tip

Available from CRM.COM R12.1.0


life_cycle_stateStringThe life cycle state of the retrieved wallet. Supported values are EFFECTIVE and CANCELLED

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

accounts_receivableAccounts Receivable ObjectThe account receivable related with the retrieved wallet
currencyCurrency Object

The wallet's currency

Tip

Available from CRM.COM R10.0.0


alternative_currencyCurrency Object

The wallet's alternative currency

Tip

Available from CRM.COM R14.2.0


wallet_balance_periodWallet Balance Period Object

The latest Wallet Balance Period for which the wallet's opening balance was calculated for.

Tip

Available from CRM.COM R12.1.0


log_informationLog Information ObjectThe log information of the retrieved wallet
product_consumption_setSet of Wallet Product Consumption ObjectsInformation related with the consumption of the wallet amount by various products
allotments_setSet of Wallet Allotment Objects

Information related with the amount allotted by the wallet


allotment_group_conditions_setSet of Wallet Allotment Group Condition Objects

Information related with the amount allotted by the wallet grouped by the conditions related with the each allotted amount

Tip

Available from CRM.COM R8.0.0

global_limitsWallet Global Limits Object

Information related with the global limits, across all wallets of the same Contact Information

Tip

Available from CRM.COM R18.0.0


Anchor
wallet referred objects
wallet referred objects
Referred Objects Response Data

...

Include Page
wallet_allotment_group_conditions_short
wallet_allotment_group_conditions_short
Include Page
wallet_global_limits_shortwallet_global_limits_short