POST wallets/cancel
- Former user (Deleted)
- p_demou (Deactivated)
This method cancels a wallet. Single wallet can be cancelled by each call. Only effective wallets can be cancelled
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 cancelled. The allowed wallet identifier fields are the following:
| |||||||||
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 |
| alternative_currency | Currency Object | The wallet's alternative currency |
| wallet_balance_period | Wallet Balance Period Object | The latest Wallet Balance Period for which the wallet's opening balance was calculated for. |
| 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 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Body:
{
"token" : "5458B970EB51B99A1DD323C885000E58",
"wallet_identifier" : { "number" : "14" }
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"est_consumption_as_of_date": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "14",
"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,
"est_consumption_days": null,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Johnson",
"middle_name": null,
"company_profile": null,
"type": "PERSON",
"first_name": "Peter",
"name": "Peter Johnson",
"id": "C73D1572FEA76C37A08945ECE4DECC98",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "7839023",
"social_security_number": "98374",
"country_of_residence":
{
"name": "CYPRUS",
"id": "181"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
},
"date_of_birth":
{
"month": 4,
"day": 6,
"year": 1985
},
"name_day":
{
"month": 6,
"day": 29
},
"id_number": "984783",
"id_issued_by_country":
{
"name": "CYPRUS",
"id": "181"
},
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "192",
"name": "Peter Johnson Premium",
"id": "2C5FC6F615FA9E798487AC0C293ECCE6"
},
"id": "38E651C88B307119317DDA6EBF3248DF",
"balance": 0,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"est_consumption_date": null,
"product_consumptions_set":
[
{
"estimated_date": "2014-09-05T00:00:00",
"estimated_days": 5,
"id": "C2A1FFDAB6CB1E7574D18AFA6AF20583",
"estimated_as_of_date": "2014-09-08T00:00:00",
"daily_amount": 12,
"available_amount": 100,
"product":
{
"product_type": null,
"id": "5A9BCF1A573AE46057BFB39F5BCCAA47",
"description": "Lord of the Rings 6",
"code": "Lord of the Rings 6",
"alternative_code": "LOR6"
}
},
{
"estimated_date": "2014-09-05T00:00:00",
"estimated_days": 5,
"id": "B81D225217C18F8212494E288E46669F",
"estimated_as_of_date": "2014-09-08T00:00:00",
"daily_amount": 1,
"available_amount": 100,
"product":
{
"product_type": null,
"id": "3535CA95FCD0B73E337D10E522802EE5",
"description": "SERENDIPITY",
"code": "SERENDIPITY",
"alternative_code": "SER"
}
}
],
"log_information":
{
"updated_date": "2014-09-01T15:20:33",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-09-01T15:19:20",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"life_cycle_state": "CANCELLED"
}
}
HTTP Method: GET
Request:
Body:
{
"token":"{{token}}",
"wallet_identifier": {"number":"W0000000239"}
}
Response:
{
"data": {
"log_information": {
"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": null,
"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-05T11:16:54",
"updated_date": "2016-07-05T11:29:19",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_date_2": "2014-06-05T15:49:59",
"product_consumption_set": [
{
"estimated_consumption_days": null,
"product": {
"code": "Gold",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "G",
"description": null,
"id": "D1EB074DFD904E54A0C67CAB9DC7E010"
},
"estimated_consumption_as_of_date": null,
"estimated_consumption_date": null,
"id": "BAC33ADD22A647EC8CE5048E0AA9F0D0"
}
],
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"number": "W0000000239",
"udf_float_3": 30,
"udf_float_4": 40,
"balance": 0,
"estimated_consumption_date": null,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "1F5212B3BA964276A4232116C48C0A5E",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_1": "TEST",
"accounts_receivable": {
"number": "ACR0000000221",
"name": "ACR0000000221 Kyriacos16 Clerides",
"id": "F73BD30B13F64BE1A181AD4115B8D758",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Kyriacos16 Clerides",
"last_name": "Clerides",
"id": "7747BAF431E9457D93D8E4A800DFFB1E",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriacos16",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "45786",
"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
}
}
},
"life_cycle_state": "CANCELLED",
"estimated_consumption_days": null,
"estimated_consumption_as_of_date": null,
"allotment_group_conditions_set": [
{
"time_conditions_set": [],
"date_conditions_set": [],
"unit_conditions_set": [],
"total_amount": 0,
"product_conditions_set": [],
"id": "AEE26407C3F1434EABA3549DC678A12A",
"number_of_conditions": 0
}
],
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "NEWTEST",
"allotments_set": [
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 0,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "AEE26407C3F1434EABA3549DC678A12A",
"product_conditions_set": [],
"id": "663FE28782CC4A2C85EA0D92BFFE70B7"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}