POST wallets/transfer_money_between_wallet_and_account

Available from CRM.COM R14.0.0

This method transfers money from an active wallet to its related accounts receivable or from an active accounts receivable to its related active wallet, if there is enough money.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

mode

(mandatory)

String

It determines if the money transferring will be performed from a wallet to an account or vice versa. The following options are supported:

WALLET_TO_ACCOUNT: If this mode is set then it is mandatory to specify a wallet from which the money transfer will be performed. The accounts receivable field is not applicable.
ACCOUNT_TO_WALLET: If this mode is set then it is mandatory to specify an accounts receivable from which the money transfer will be performed. The wallet field is not applicable.

wallet_identifier
(semi-optional)

Wallet identifier

The identifier of the wallet from which the money will be transferred. Note that this information is applicable and mandatory only if the mode is set to WALLET_TO_ACCOUNT.

The allowed wallets identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet

number

(semi-optional)

String

The number of the wallet

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable from which the money will be transferred. Note that this information is applicable and mandatory only if the mode is set to ACCOUNT_TO_WALLET.

The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

amount

(mandatory)

Float

The amount that will be transferred from the active wallet to its related accounts receivable or from the active accounts receivable to its related active wallet based on the mode selected

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.

Response Data

Name	Type	Description
id	String	The ID of the retrieved wallet
number	String	The number of the retrieved wallet
estimated_consumption_days	Number	An estimation on the number of days left until the whole wallet amount will be consumed
estimated_consumption_date	Date	An estimation of the date on which the whole wallet amount will be consumed
estimated_consumption_as_of_date	Date	The latest date that the estimation was performed
balance	Number	The balance of the retrieved wallet in wallet currency
alternative_balance	Number	The balance of the retrieved wallet in wallet alternative currency Available from CRM.COM R14.2.0
opening_balance	Number	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 Available from CRM.COM R12.1.0
opening_alternative_balance	Number	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 Available from CRM.COM R14.2.0
opening_balance_date	Date	The date on which the wallet's opening balance was last updated. Available from CRM.COM R12.1.0
life_cycle_state	String	The 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_receivable	Accounts Receivable Object	The account receivable related with the retrieved wallet
currency	Currency Object	The wallet's currency Available from CRM.COM R10.0.0
alternative_currency	Currency Object	The wallet's alternative currency Available from CRM.COM R14.2.0
wallet_balance_period	Wallet Balance Period Object	The latest Wallet Balance Period for which the wallet's opening balance was calculated for. Available from CRM.COM R12.1.0
log_information	Log Information Object	The log information of the retrieved wallet
product_consumption_set	Set of Wallet Product Consumption Objects	Information related with the consumption of the wallet amount by various products
allotments_set	Set of Wallet Allotment Objects	Information related with the amount allotted by the wallet
allotment_group_conditions_set	Set 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 Available from CRM.COM R8.0.0

Referred Objects Response Data

accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
number	String	The number of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

wallet balance period object response data

Name	Type	Description
number	String	The Wallet Balance Period's number
name	String	The Wallet Balance Period's name
from_date	Date	The Wallet Balance Period's from date
to_date	Date	The Wallet Balance Period's to date
life_cycle_state	Sting	The Wallet Balance Period's life cycle state. Available values are OPEN and CLOSED
closed_date	Date	The Wallet Balance Period's closed date. Available only for Wallet Balance Periods in Closed life cycle state

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved user was created
updated_date	Date	The last date that the retrieved user was updated
process_name	String	The name of the process that created or canceled the wallet
entity_name	String	The name of the entity that caused the creation or cancellation of the wallet
entity_value	String	The value of the entity that caused the creation or cancellation of the wallet
created_by_unit	Unit Object	The name of unit that created the retrieved user
created_by_user	User Object	The name of user that created the retrieved user
updated_by_unit	Unit Object	The name of the last unit that updated the retrieved user
updated_by_user	User Object	The name of the last user that updated the retrieved user

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

wallet_product_consumption object response data

Name	Type	Description
id	String	The ID of the retrieved wallet product consumption
estimated_consumption_days	Number	An estimation on the number of days left until the whole wallet amount allotted for the specified product will be consumed
estimated_consumption_date	Date	An estimation of the date on which the whole wallet amount allotted for the specified product will be consumed
estimated_consumption_as_of_date	Date	The latest date that the estimation was performed
product	Product Object	The product related with the consumption information

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

wallet_allotment object response data

Name	Type	Description
id	String	The ID of the retrieved wallet allotment
group_condition_id	String	The ID of the group condition related with the retrieved wallet allotment Available from CRM.COM R8.0.0
amount	Number	The amount that was allotted by the retrieved wallet allotment in wallet currency
alternative_amount	Number	The amount that was allotted by the retrieved wallet allotment in wallet alternative currency Available from CRM.COM R14.2.0
validity_date	Date	The date that the retrieved wallet allotment becomes valid for consumption
wallet_balance_date	Date	The date on which this wallet allotment was included in a Wallet Balance Period Available from CRM.COM R12.0.0
wallet_balance_period	Wallet Balance Period Object	The Wallet Balance Period within which this allotment falls within Available from CRM.COM R12.0.0
time_conditions_set	Set of Allotment Time Condition Objects	The time conditions related with the retrieved wallet allotment
product_conditions_set	Set of Allotment Product Condition Objects	The product conditions related with the retrieved wallet allotment
unit_conditions_set	Set of Allotment Unit Condition Objects	The unit conditions related with the retrieved wallet allotment
date_conditions_set	Set of Allotment Date Condition Objects	The date conditions related with the retrieved wallet allotment

Referred Objects Response Data

wallet balance period object response data

Name	Type	Description
number	String	The Wallet Balance Period's number
name	String	The Wallet Balance Period's name
from_date	Date	The Wallet Balance Period's from date
to_date	Date	The Wallet Balance Period's to date
life_cycle_state	Sting	The Wallet Balance Period's life cycle state. Available values are OPEN and CLOSED
closed_date	Date	The Wallet Balance Period's closed date. Available only for Wallet Balance Periods in Closed life cycle state

allotment_time_condition object response data

Name	Type	Description
id	String	The ID of the retrieved allotment condition
from	Number	The start of the time period condition related with the retrieved allotment condition
to	Number	The end of the time period condition related with the retrieved allotment condition

allotment_product_condition object response data

Name	Type	Description
id	String	The ID of the retrieved allotment condition
product	Product object	The product related with the retrieved allotment condition
product_type	Product Type object	The product type related with the retrieved allotment condition
product_family	Product Family object	The product family related with the retrieved allotment condition Available from CRM.COM Rx.0.0
product_brand	Product Brand object	The product brand related with the retrieved allotment condition Available from CRM.COM R15.0.0
product_category	Product Category object	The product category related with the retrieved allotment condition Available from CRM.COM R15.0.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

product_brand object data response

Name	Type	Description
Id	String	The ID of the retrieved product brand
name	String	The Name of the retrieved product brand
alternative_code	String	The Alternative Code of the retrieved product brand
description	String	The Description of the retrieved product brand

product_category response data object

Name	Type	Description
Id	String	The ID of the retrieved product category
name	String	The Name of the retrieved product category
code	String	The code of the retrieved product category
description	String	The Description of the retrieved product category

allotment_unit_condition object response data

Name	Type	Description
id	String	The ID of the retrieved allotment condition
business_unit	Business Unit Object	The business unit related with the retrieved allotment condition Available from CRM.COM R18.0.0
unit	Unit object	The unit related with the retrieved allotment condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)
group	Group object	The group related with the retrieved allotment condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

allotment_date_condition object response data

Name

Type

Description

id

String

The ID of the retrieved allotment condition

day_of_week

Number

The day of week condition related with the retrieved allotment condition. The supported values are the following:

MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

wallet_allotment_group_condition object response data

Name	Type	Description
id	String	The ID of the retrieved wallet allotment group condition
number_of_conditions	Number	The total number of conditions related with the retrieved wallet allotment group condition
total_amount	Number	The total amount in wallet currency, that is allotted by the retrieved wallet allotment group condition
total_alternative_amount	Number	The total amount in wallet alternative currency, that is allotted by the retrieved wallet allotment group condition Available from CRM.COM R14.2.0
allotment_group_opening_balance	Number	The opening balance of this wallet allotment group of conditions - in wallet currency - as this was calculated in the latest wallet balance period. Available from CRM.COM R12.0.0
allotment_group_opening_alternative_balance	Number	The opening balance of this wallet allotment group of conditions - in wallet alternative currency - as this was calculated in the latest wallet balance period Available from CRM.COM R14.2.0
opening_balance_date	Date	The date on which the allotment group of conditions balance was calculated Available from CRM.COM R12.1.0
wallet_balance_period	Wallet Balance Period Object	The Wallet balance period within which this wallet allotment group condition falls within Available from CRM.COM R12.1.0
time_conditions_set	Set of Allotment Time Condition Objects	The time conditions related with the retrieved wallet allotment group condition
product_conditions_set	Set of Allotment Product Condition Objects	The product conditions related with the retrieved wallet allotment group condition
unit_conditions_set	Set of Allotment Unit Condition Objects	The unit conditions related with the retrieved wallet allotment group condition
date_conditions_set	Set of Allotment Date Condition Objects	The date conditions related with the retrieved wallet allotment group condition

Referred Objects Response Data

wallet balance period object response data

Name	Type	Description
number	String	The Wallet Balance Period's number
name	String	The Wallet Balance Period's name
from_date	Date	The Wallet Balance Period's from date
to_date	Date	The Wallet Balance Period's to date
life_cycle_state	Sting	The Wallet Balance Period's life cycle state. Available values are OPEN and CLOSED
closed_date	Date	The Wallet Balance Period's closed date. Available only for Wallet Balance Periods in Closed life cycle state

allotment_time_condition object response data

Name	Type	Description
id	String	The ID of the retrieved allotment condition
from	Number	The start of the time period condition related with the retrieved allotment condition
to	Number	The end of the time period condition related with the retrieved allotment condition

allotment_product_condition object response data

Name	Type	Description
id	String	The ID of the retrieved allotment condition
product	Product object	The product related with the retrieved allotment condition
product_type	Product Type object	The product type related with the retrieved allotment condition
product_family	Product Family object	The product family related with the retrieved allotment condition Available from CRM.COM Rx.0.0
product_brand	Product Brand object	The product brand related with the retrieved allotment condition Available from CRM.COM R15.0.0
product_category	Product Category object	The product category related with the retrieved allotment condition Available from CRM.COM R15.0.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

product_brand object data response

Name	Type	Description
Id	String	The ID of the retrieved product brand
name	String	The Name of the retrieved product brand
alternative_code	String	The Alternative Code of the retrieved product brand
description	String	The Description of the retrieved product brand

product_category response data object

Name	Type	Description
Id	String	The ID of the retrieved product category
name	String	The Name of the retrieved product category
code	String	The code of the retrieved product category
description	String	The Description of the retrieved product category

allotment_unit_condition object response data

Name	Type	Description
id	String	The ID of the retrieved allotment condition
business_unit	Business Unit Object	The business unit related with the retrieved allotment condition Available from CRM.COM R18.0.0
unit	Unit object	The unit related with the retrieved allotment condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)
group	Group object	The group related with the retrieved allotment condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

allotment_date_condition object response data

Name

Type

Description

id

String

The ID of the retrieved allotment condition

day_of_week

Number

The day of week condition related with the retrieved allotment condition. The supported values are the following:

MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Examples

Example 1

HTTP Method: POST

Request:

Body:

Response: