- Created by Former user, last modified by p_demou on Jun 05, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Current »
Available from CRM.COM R12.0.0
Deprecated from CRM.COM R18.0.0
This method is used to get wallet transactions which are not related to any wallet balance period and as a result, their amounts are not included in the opening balance of the wallet for the currently open wallet balance period. Wallet transactions of a single wallet can be retrieved by each call.
Resource URL
Parameters
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | |||||||||
wallet_identifier (mandatory) | Wallet Identifier | The identifier of the wallet that should be returned as a result. The allowed wallets identifier fields are the following:
| |||||||||
number (optional) | Number | The number of wallet transactions to be retrieved, starting from the latest one | |||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
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'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:
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
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 |
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
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
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 Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects 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 Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects 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 | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
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
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
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 |
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 |
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 |
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 |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects 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
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
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 |
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 |
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 |
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 |
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
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 |
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 |
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 | |
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 | |
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 | |
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 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
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
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 |
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 |
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 |
String | The email of the retrieved user |
Examples
HTTP Method: GET
Request:
Body:
Response:
{ "data": [ { "number": "48609", "amount": 50, "wallet": { "number": "W0000002918", "accounts_receivable": { "number": "ACR0000003381", "name": "John sqrxlbvbvw. 6390 Account", "id": "4CAD31A8BDA84069B63F6C96C7069AEF", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": null, "company_name": null, "name": "John Donzk 703", "last_name": "Donzk 703", "id": "7278214BE871462AA5824BF07E3CC4A6", "life_cycle_state": "FINANCIAL", "middle_name": "N.", "title": null, "type": "PERSON", "first_name": "John", "demographics": { "name_day": { "month": null, "day": null }, "id_number": null, "gender": null, "country_of_residence": { "alternative_code": "CYP", "three_character_code": "CYP", "name": "CYPRUS", "id": "181", "two_character_code": "CY" }, "date_of_birth": { "month": null, "year": null, "day": null }, "industry_sector": null, "passport_number": null, "industry": null, "social_security_number": null, "id_issued_by_country": null, "passport_issued_by_country": null } } }, "id": "20306BBB3F514B6890539D8F50830C3E", "life_cycle_state": "EFFECTIVE" }, "log_information": { "created_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "updated_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "created_date": "2017-02-09T16:45:21", "updated_date": "2017-02-09T16:45:40", "updated_by_user": { "person_name": "MPAdministrator", "id": "1", "email": "dev@crm.com", "username": "MPAdministrator" }, "created_by_user": { "person_name": "MPAdministrator", "id": "1", "email": "dev@crm.com", "username": "MPAdministrator" } }, "caused_by_entity": null, "currency_rate_period": null, "id": "2E29B06370FF4A45A4BD37D636ABF4A7", "life_cycle_state": "EFFECTIVE", "extra_added_amount": null, "type": { "alternative_code": "WC", "name": "Wallet Credit", "description": "Wallet Credit", "id": "CA1B3E67E5A6F899512CEFE24E40875B", "classification": "CREDIT" }, "caused_by_entity_id": null } ], "status": { "code": "OK", "description": "", "message": "" } }
- No labels