POST wallet_transactions/void

This method voids a wallet transaction. Single transaction can be voided by each call. Can be applied only on effective wallets and only on wallet transactions which were not already voided.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

wallet_transaction_identifier
(mandatory)

Wallet Transaction Identifier

The identifier of the wallet transactions to be voided. The allowed wallet transaction identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet transaction

number

(semi-optional)

String

The number of the wallet transaction

type_identifier
(mandatory)

Wallet Transaction Type identifier

The identifier of the type, classified as wallet void transaction, that will be used to void the wallet transaction. The allowed wallet transaction type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet transaction type

name

(semi-optional)

String

The name of the wallet transaction type

alternative_code

(semi-optional)

String

The alternative code of the wallet transaction type

notes
(optional)

String

The notes of the wallet transaction

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_string_9
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

udf_string_10
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

udf_string_11
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

udf_string_12
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

udf_string_13
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

udf_string_14
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

udf_string_15
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

udf_string_16
(optional)

String

User Defined Field of type String

Available from CRM.COM R11.1.0

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_float_5
(optional)

Float

User Defined Field of type Float

Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards

udf_float_6
(optional)

Float

User Defined Field of type Float

Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards

udf_float_7
(optional)

Float

User Defined Field of type Float

Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards

udf_float_8
(optional)

Float

User Defined Field of type Float

Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards

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

udf_date_5
(optional)

Date

User Defined Field of type Date

Available from CRM.COM R13.0.0

udf_date_6
(optional)

Date

User Defined Field of type Date

Available from CRM.COM R13.0.0

udf_date_7
(optional)

Date

User Defined Field of type Date

Available from CRM.COM R13.0.0

udf_date_8
(optional)

Date

User Defined Field of type Date

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

Available from CRM.COM R10.0.0

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 transaction
number	String	The number of the retrieved wallet transaction
amount	Number	The total amount of the wallet transaction in wallet currency
alternative_amount	Number	The total amount of the wallet transaction in wallet alternative currency Available from CRM.COM R14.2.0
extra_added_amount	Number	An extra added amount that will only affect the wallet balance on crediting the wallet in wallet currency
extra_added_alternative_amount	Number	An extra added amount that will only affect the wallet balance on crediting the wallet in wallet alternative currency Available from CRM.COM R14.2.0
notes	String	The notes for the retrieved wallet transaction
life_cycle_state	String	The life cycle state of the retrieved wallet transaction. Supported values are EFFECTIVE and VOIDED
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_string_9	String	User Defined Field of type String Available from CRM.COM R11.1.0
udf_string_10	String	User Defined Field of type String Available from CRM.COM R11.1.0
udf_string_11	String	User Defined Field of type String Available from CRM.COM R11.1.0
udf_string_12	String	User Defined Field of type String Available from CRM.COM R11.1.0
udf_string_13	String	User Defined Field of type String Available from CRM.COM R11.1.0
udf_string_14	String	User Defined Field of type String Available from CRM.COM R11.1.0
udf_string_15	String	User Defined Field of type String Available from CRM.COM R11.1.0
udf_string_16	String	User Defined Field of type String Available from CRM.COM R11.1.0
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_float_5	Float	User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
udf_float_6	Float	User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
udf_float_7	Float	User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
udf_float_8	Float	User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
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
udf_date_5	Date	User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
udf_date_6	Date	User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
udf_date_7	Date	User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
udf_date_8	Date	User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards
caused_by_entity	String	The name of the entity that caused the creation of the wallet transaction. The supported values are the following: PREPAIDBILLINGRUN RATEDBILLINGITEMS REWARDAWARDTRANSACTIONS AWARDEXPIRATIONTRANSACTIONS REWARDSPENDTRANSACTIONS PAYMENTS CREDITNOTES Available from CRM.COM R10.1.0
caused_by_entity_id	String	The id of the entity that caused the creation of the wallet transaction. Available from CRM.COM R10.1.0
wallet_balance_date	Date	The date on which the wallet transaction's amount was included in the Wallet's balance calculation for a specific wallet balance period Available from CRM.COM R12.1.0
type	Wallet Transaction Type Object	The type of the retrieved wallet transaction
wallet	Wallet Object	The wallet related with the retrieved wallet transaction
to_wallet	Wallet Object	The wallet to which money is transferred to through the retrieved wallet transaction. Applicable only for Wallet Transfer Transactions Available from CRM.COM R9.0.0
voided_by_wallet_transaction	Wallet Transaction Object	The wallet transaction that voided the retrieved wallet transaction
transferred_by_wallet_transaction	Wallet Transaction Object	The wallet transaction through which money was transferred to another wallet. Applicable only when the wallet transaction is related to another Wallet Transaction with classification Transfer Available from CRM.COM R9.0.0
initiated_by_wallet_transaction	Wallet Transaction Object	The wallet transaction that initiated the creation of the retrieved wallet transaction. Available from CRM.COM R15.0.0
log_information	Log Information Object	The log information of the retrieved wallet transaction
initiated_currency	Currency Object	The currency in which the wallet transaction was initiated in
currency_rate_period	Currency Rate Period	The currency rate period of the wallet transaction Available from CRM.COM R10.0.0
wallet_balance_period	Wallet Balance Period Object	The wallet balance period in which this wallet transaction was included. Available from CRM.COM R12.1.0
products_set	Set of Wallet Transaction Products Objects	Set of wallet transaction products used to keep track of the products that resulted to the wallet transaction amount

Referred Objects Response Data

wallet_transaction_type response data object

Name	Type	Description
Id	String	The ID of the retrieved wallet transaction type
name	String	The Name of the retrieved wallet transaction type
alternative_code	String	The Alternative Code of the retrieved wallet transaction type
classification	String	The Classification of the retrieved wallet transaction type. The supported classifications are CREDIT, DEBIT, REIMBURSE, VOID, TRANSFER TRANSFER classification available from CRM.COM R9.0.0
description	String	The Description of the retrieved wallet transaction type

wallet response data object

Name	Type	Description
id	String	The ID of the retrieved wallet
number	String	The number of the retrieved wallet
life_cycle_state	String	The life cycle state of the retrieved wallet. Supported values are EFFECTIVE and CANCELLED
accounts_receivable	Accounts Receivable Object	The account receivable related with the retrieved wallet

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

wallet_transaction response data object

Name	Type	Description
id	String	The ID of the retrieved wallet transaction
number	String	The number of the retrieved wallet transaction
amount	Number	The total amount of the wallet transaction in wallet's currency
alternative_amount	Number	The total amount of the wallet transaction in the wallet's alternative currency Available from CRM.COM R14.2.0
extra_added_amount	Number	An extra added amount that will only affect the wallet balance on crediting the wallet.
extra_added_alternative_amount	Number	An extra added amount in the alternative currency that will only affect the wallet balance on crediting the wallet. Available from CRM.COM R14.2.0
life_cycle_state	String	The life cycle state of the retrieved wallet transaction. Supported values are EFFECTIVE and VOIDED
caused_by_entity	String	The name of the entity that caused the creation of the wallet transaction. The supported values are the following: PREPAIDBILLINGRUN RATEDBILLINGITEMS REWARDAWARDTRANSACTIONS AWARDEXPIRATIONTRANSACTIONS REWARDSPENDTRANSACTIONS PAYMENTS CREDITNOTES Available from CRM.COM R10.1.0
caused_by_entity_id	String	The id of the entity that caused the creation of the wallet transaction. Available from CRM.COM R10.1.0
type	Wallet Transaction Type Object	The type of the retrieved wallet transaction
wallet	Wallet Object	The wallet related with the retrieved wallet transaction
initiated_currency	Currency Object	The currency in which the wallet transaction was initiated in Available from CRM.COM R14.2.0
currency_rate_period	Currency Rate Period	The currency rate period of the wallet transaction Available from CRM.COM R10.1.0
log_information	Log Information Object	The log information of the retrieved wallet transaction

Referred Objects Response Data

wallet_transaction_type response data object

Name	Type	Description
Id	String	The ID of the retrieved wallet transaction type
name	String	The Name of the retrieved wallet transaction type
alternative_code	String	The Alternative Code of the retrieved wallet transaction type
classification	String	The Classification of the retrieved wallet transaction type. The supported classifications are CREDIT, DEBIT, REIMBURSE, VOID, TRANSFER TRANSFER classification available from CRM.COM R9.0.0
description	String	The Description of the retrieved wallet transaction type

wallet response data object

Name	Type	Description
id	String	The ID of the retrieved wallet
number	String	The number of the retrieved wallet
life_cycle_state	String	The life cycle state of the retrieved wallet. Supported values are EFFECTIVE and CANCELLED
accounts_receivable	Accounts Receivable Object	The account receivable related with the retrieved wallet

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

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The Currency with which the returned exchange rate information refers to

Referred Objects Response Data

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

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

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

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

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

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

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

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The Currency with which the returned exchange rate information refers to

Referred Objects Response Data

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

wallet_transaction_product response data object

Name	Type	Description
id	String	The ID of the wallet transaction product
product	Product Object	The product related with the wallet transaction

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

Examples

Example 1

HTTP Method: POST

Request:

Body:

{
"token":"896D1092404D4659986E505ED8F0A25A",
"wallet_transaction_identifier":{"number":"WT001425"},
"type_identifier":{"name":"Normal Void"}
}

Response:

    {
        "status":
        {
            "message": "",
            "description": "",
            "code": "OK"
        },
        "data":
        {
            "notes": null,
            "extra_added_amount": null,
            "udf_float_1": null,
            "products_set":
            [
            ],
            "transferred_by_wallet_transaction": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "number": "WT001430",
            "udf_float_4": null,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "amount": 22,
            "id": "E6B9DD43D29B4303B7968EC52542F6DD",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2016-01-14T18:30:02",
                "created_date": "2016-01-14T18:27:54",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "voided_by_wallet_transaction": null,
            "life_cycle_state": "EFFECTIVE",
            "wallet":
            {
                "life_cycle_state": "EFFECTIVE",
                "accounts_receivable":
                {
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000280",
                    "id": "FFB13D978205EE8CED5BEFB3869C1958",
                    "name": "Anthony Barlow 21"
                },
                "number": "WLT000012",
                "id": "1209C68830BD37711224295BD099B462"
            },
            "type":
            {
                "classification": "VOID",
                "id": "1EE27DC8528083BAF4887DF632D240FA",
                "name": "Normal Void",
                "description": "Normal Void for Wallets",
                "alternative_code": "NV"
            },
            "to_wallet":
            {
                "life_cycle_state": "EFFECTIVE",
                "number": "WLT000018",
                "id": "C03F1702C2138A0E70623DBEC80F66CF"
            }
        }
    }

Example 2

HTTP Method: POST

Request:

Body:

{
"token":"896D1092404D4659986E505ED8F0A25A",
"wallet_transaction_identifier":{"number":"WT002353"},
"fields_set":"wallet,type,voided_by_wallet_transaction,transferred_by_wallet_transaction,products_set",
"type_identifier":{"name":"Normal Void"}
}

Response:

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "voided_by_wallet_transaction": null,
    "products_set": [],
    "transferred_by_wallet_transaction": null,
    "wallet": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Tzirtzipi1",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": null,
          "first_name": "Katerina",
          "type": "PERSON",
          "id": "8DA02E4C939148EBA4867D80E7B44C1A",
          "name": "Tzirtzipi1 Katerina",
          "company_name": null,
          "demographics": {
            "gender": null,
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "CYP",
              "two_character_code": "CY",
              "id": "181",
              "name": "CYPRUS",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": null,
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR000962",
        "id": "D69FB8EAC5674B699D90CD9EB4B55260",
        "name": "ACR000962"
      },
      "number": "WLT000417",
      "id": "0A38D7415AAF45EFBE06B52CA3658295"
    },
    "type": {
      "classification": "VOID",
      "id": "1EE27DC8528083BAF4887DF632D240FA",
      "name": "Normal Void",
      "description": "Normal Void for Wallets",
      "alternative_code": "NV"
    }
  }
}

Example 3

HTTP Method: POST

Request:

Body:

{
"token":"896D1092404D4659986E505ED8F0A25A",
"wallet_transaction_identifier":{"number":"1692"},
"type_identifier":{"name":"Wallet Void"}
}

Response:

 {
  "data": {
    "notes": null,
    "log_information": {
      "entity_value": null,
      "entity_name": null,
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "process_name": "MANUALLY",
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-07-19T08:35:43",
      "updated_date": "2016-07-19T08:40:52",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      }
    },
    "currency_rate_period": {
      "from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
      "to_date": 0.25,
      "rate": 0.25,
      "inverse_rate": 4,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": null,
        "decimal_part_name": null,
        "code": "FJD",
        "integer_part_name": null,
        "id": "93"
      },
      "id": "0EEE31A81A064D97A9873F5676D2F4D9"
    },
    "udf_date_2": null,
    "type": {
      "alternative_code": "WV",
      "name": "Wallet Void",
      "description": "Wallet Void",
      "id": "19BB2CCA356F4564BA6E268CC17CD335",
      "classification": "VOID"
    },
    "udf_date_1": null,
    "udf_date_4": "2014-08-05T15:49:59",
    "products_set": [],
    "udf_date_3": null,
    "number": "1693",
    "udf_float_3": null,
    "to_wallet": null,
    "udf_float_4": null,
    "id": "F8DFAF9263F145F3B3C7A37482D5AB4C",
    "extra_added_amount": null,
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": "udf string 2",
    "udf_string_3": "udf string 3",
    "amount": 20,
    "udf_string_4": "udf string 4",
    "udf_string_5": null,
    "wallet": {
      "number": "W0000000220",
      "accounts_receivable": {
        "number": "ACR0000000238",
        "name": "Test",
        "id": "292CEF408C5C4EEEA5F5C5DC03B895F2",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": {
            "tax_reference_number": null,
            "registered_in_country": null,
            "number_of_employees": null,
            "annual_turnover": null,
            "profile_year": null,
            "registration_number": null,
            "vat_registration_number": null,
            "industry_sector": null,
            "industry": null,
            "established_date": null,
            "vat_registered_by": null,
            "vat_registration_date": null
          },
          "company_name": "CRM.COM Template Company",
          "name": "CRM.COM Template Company",
          "last_name": "COM",
          "id": "44F091F6840A5BB9E27940831346633D",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "COMPANY",
          "first_name": "CRM",
          "demographics": null
        }
      },
      "id": "C5622001B9594553ADA9594F6413D450",
      "life_cycle_state": "EFFECTIVE"
    },
    "udf_string_1": "udf string 1",
    "transferred_by_wallet_transaction": null,
    "life_cycle_state": "EFFECTIVE",
    "voided_by_wallet_transaction": null,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}