Available from CRM.COM R4.0.0
GET wallets/show
This method returns information related with a wallet. Single wallet is returned 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:
| |||||||||
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:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"allotments_set":
[
{
"unit_conditions_set":
[
{
"unit":
{
"name": "Call Centre London",
"id": "BCF879BAF2C15BC5B32471C96DD33BA0",
"alternative_code": "CCL"
},
"id": "A67243AB794644528F2436B9E67EAEAE"
},
{
"id": "46EFD09BF48A4AA5A4D6265E2079109B",
"group":
{
"community_name": "Internal Community",
"name": "Installation Group",
"id": "D7EFC36B3E12FCB5B172D060713A5D09",
"alternative_code": "IG"
}
}
],
"amount": 150,
"product_conditions_set":
[
],
"id": "A471F96A4AD441B599738B992A34B157",
"date_conditions_set":
[
],
"time_conditions_set":
[
]
},
{
"unit_conditions_set":
[
],
"amount": 50,
"product_conditions_set":
[
],
"validity_date": "2015-05-31T14:38:26",
"id": "DC438CF4594545D69C13337CBF803611",
"date_conditions_set":
[
],
"time_conditions_set":
[
]
},
{
"unit_conditions_set":
[
],
"amount": 150,
"product_conditions_set":
[
],
"id": "710F483AA4A84870A9E0B243CF1E9932",
"date_conditions_set":
[
{
"day_of_week": "MONDAY",
"id": "04FFC5E7B27C4C8D9CCFEB800D9C71C7"
}
],
"time_conditions_set":
[
]
}
],
"accounts_receivable":
{
"account_owner":
{
"last_name": "McMillan",
"life_cycle_state": "FINANCIAL",
"type": "PERSON",
"first_name": "Adrew",
"name": "Adrew McMillan",
"id": "403B55EA7311D3C9543C7D3B4D4682ED",
"demographics":
{
"gender": "MALE",
"passport_issued_by_country":
{
"three_character_code": "GBR",
"two_character_code": "GB",
"name": "UNITED KINGDOM",
"id": "126"
},
"passport_number": "943030",
"social_security_number": "940321",
"country_of_residence":
{
"three_character_code": "GBR",
"two_character_code": "GB",
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "EDUCATION",
"id": "AF6E0855324153EAB8B582A277147BCE",
"alternative_code": "1"
},
"date_of_birth":
{
"month": 5,
"day": 8,
"year": 1982
},
"name_day":
{
},
"id_number": "987908",
"id_issued_by_country":
{
"three_character_code": "GBR",
"two_character_code": "GB",
"name": "UNITED KINGDOM",
"id": "126"
},
"industry":
{
"name": "Marketing",
"id": "31BC2070C79EAE5455BFAD41599C5190",
"code": "MK"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "176",
"name": "McMillan Standard Account",
"id": "5B919C3F99DEA0AC4CE45F5CAB0F887A"
},
"number": "3",
"id": "B3F5467A45D250CC5F76312C3A094A67",
"product_consumption_set":
[
{
"estimated_consumption_as_of_date": "2014-08-27T00:00:00",
"estimated_consumption_date": "2014-09-07T00:00:00",
"id": "D9CBFD486339B9216E73B4257B7F9F28",
"estimated_consumption_days": 8,
"product":
{
"product_type":
{
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "Usage - Flat",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "DF57C72BAF0260C26BA558CC06862448",
"description": "Video On Demand Service",
"code": "Video On Demand Service",
"alternative_code": "VOD"
}
}
]
}
}
HTTP Method: GET
Request:
Response:
{
"data": {
"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-09-07T11:12:40",
"updated_date": "2017-02-07T12:50:04",
"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"
}
},
"udf_date_2": null,
"product_consumption_set": [],
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "W0000003063",
"udf_float_3": null,
"udf_float_4": null,
"balance": 141,
"estimated_consumption_date": null,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "0D55E0832E1F4E80A9751FB27B192388",
"opening_balance": 141,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": "2017-02-07T12:50:04",
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000003626",
"name": "ACR0000003626",
"id": "9DCD7573B21B4DD59FDFBBE0E70C6027",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Loukia Louka",
"last_name": "Louka",
"id": "104CAD82465C485FB78EF473A1A635CE",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Loukia",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "ll1234",
"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": "EFFECTIVE",
"estimated_consumption_days": 0,
"wallet_balance_period": {
"number": "201612",
"closed_date": "2017-02-07T12:50:04",
"from_date": "2016-12-01T00:00:00",
"to_date": "2016-12-31T23:59:59",
"name": "December 2016",
"life_cycle_state": "CLOSED"
},
"estimated_consumption_as_of_date": null,
"allotment_group_conditions_set": [
{
"time_conditions_set": [],
"date_conditions_set": [],
"unit_conditions_set": [],
"total_amount": 141,
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:14:34",
"id": "816ABAD692584CB582B6E09793CB6793",
"number_of_conditions": 0
}
],
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"allotments_set": [
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -4,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "3DB83B7222814A27A21F9E503B398596"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 50,
"wallet_balance_period": {
"number": "201610",
"closed_date": "2017-02-07T12:14:34",
"from_date": "2016-10-01T00:00:00",
"to_date": "2016-10-31T23:59:59",
"name": "October 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": "2016-10-04T00:00:00",
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:14:34",
"id": "71218D348BBA4344B9CEF5E475A3002F"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -7,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "3E986C463BCC4E0A9B33B1F12D15B6FB"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 2,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "161D9AA51C75439ABE9C856B2CE7955B"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -20,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "9C38C4A4D9B94F718690FD9714E1FE7D"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 7,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "0259D0EA9CDD4886B0A121C2017475A4"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -45,
"wallet_balance_period": {
"number": "201610",
"closed_date": "2017-02-07T12:14:34",
"from_date": "2016-10-01T00:00:00",
"to_date": "2016-10-31T23:59:59",
"name": "October 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": "2016-10-11T00:00:00",
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:14:34",
"id": "319AD392922B459182598EC33CDC367F"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 100,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "6E01C393D30145DE95B57D037CE57BEA"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -2,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "A0EF8D25D74345AD82D6A35B2F0F74EC"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 60,
"wallet_balance_period": {
"number": "201609",
"closed_date": "2017-02-07T12:11:54",
"from_date": "2016-09-01T00:00:00",
"to_date": "2016-09-30T23:59:59",
"name": "September 2016",
"life_cycle_state": "CLOSED"
},
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "816ABAD692584CB582B6E09793CB6793",
"product_conditions_set": [],
"wallet_balance_date": "2017-02-07T12:11:54",
"id": "4FFCE7F161C8434285E27200D6C843BD"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET wallets/list
This method returns information related with wallets. Multiple wallets are returned by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
accounts_receivable_identifier | Accounts Receivable identifier | The identifier of the accounts receivable related with the wallets that should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
subscription_identifier (semi-optional) | Subscription Identifier | The identifier of the subscription owned by the accounts receivable related with the wallets that should be returned as a result. The allowed subscription 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:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"est_consumption_as_of_date": "2014-09-08T09:00:00",
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "6",
"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": 12,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou8",
"middle_name": null,
"company_profile": null,
"type": "PERSON",
"first_name": "Marios",
"name": "Marios Ioannou8",
"id": "02CAECDF0FA0796746DD961DF7C8EA5B",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "JAPAN",
"id": "237"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "59",
"name": "mar8",
"id": "016BD62BE2039A406DF91929AD275BCF"
},
"id": "D347CAD0BC050B6ED458A88B1A2A0056",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"product_consumptions_set": null,
"udf_date_4": null,
"est_consumption_date": "2014-09-08T09:00:00",
"log_information":
{
"updated_date": "2014-08-26T09:10:50",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-08-26T09:10:19",
"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": "EFFECTIVE"
},
{
"est_consumption_as_of_date": "2014-09-08T09:00:00",
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "7",
"udf_float_4": null,
"udf_string_1": "TEST",
"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": "NEWTEST",
"est_consumption_days": 12,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou8",
"middle_name": null,
"company_profile": null,
"type": "PERSON",
"first_name": "Marios",
"name": "Marios Ioannou8",
"id": "02CAECDF0FA0796746DD961DF7C8EA5B",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "JAPAN",
"id": "237"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "59",
"name": "mar8",
"id": "016BD62BE2039A406DF91929AD275BCF"
},
"id": "44502110F058EB76B86FCF5B0EA90A15",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"product_consumptions_set": null,
"udf_date_4": null,
"est_consumption_date": "2014-09-08T09:00:00",
"log_information":
{
"updated_date": "2014-08-26T09:12: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-08-26T09:12:25",
"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": "EFFECTIVE"
},....
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"log_information": {
"entity_value": "0000000001",
"entity_name": "ACCOUNTS_RECEIVABLE",
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"process_name": "ACCOUNTS_RECEIVABLE",
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-08T16:01:34",
"updated_date": "2016-02-08T16:01:34",
"updated_by_user": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"email": "crm.com.tst@gmail.com",
"username": "emichailidou"
},
"created_by_user": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"email": "crm.com.tst@gmail.com",
"username": "emichailidou"
}
},
"udf_date_2": null,
"product_consumption_set": [],
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "W0000000021",
"udf_float_3": null,
"udf_float_4": null,
"balance": 3650,
"estimated_consumption_date": null,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "1B9E0C4696D94007AC73BDE30ED26AD8",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "0000000001",
"name": "0000000001 Eleni M",
"id": "8DDDA5F17D9641FC97A32FEAEE1F8AC6",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Eleni Mich",
"last_name": "Mich",
"id": "EE15F92F5AD9487692DA4DD34D35CA09",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Eleni",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "451232",
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"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": "EFFECTIVE",
"estimated_consumption_days": null,
"estimated_consumption_as_of_date": null,
"allotment_group_conditions_set": [
{
"time_conditions_set": [
{
"from": 10,
"id": "9C6A564EC57E4EB78A59B67A1F71D9DF",
"to": 22
}
],
"date_conditions_set": [
{
"id": "763ED45F7F614839A14C52AFBA6B74CE",
"day_of_week": "FRIDAY"
},
{
"id": "6338B7CA578F4156904A03EFA9A24E49",
"day_of_week": "TUESDAY"
},
{
"id": "B28836F4270F46B5AEDC504409DD8241",
"day_of_week": "THURSDAY"
},
{
"id": "0BB8EB803C55412A971585397649EB0D",
"day_of_week": "WEDNESDAY"
},
{
"id": "C9BAB89E57A646338497E684AB6FB1BC",
"day_of_week": "MONDAY"
}
],
"unit_conditions_set": [],
"total_amount": 20,
"product_conditions_set": [],
"id": "36AF0DFF9F2E4DFDA6248EDE7AC910C9",
"number_of_conditions": 6
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"unit_conditions_set": [],
"total_amount": 3615,
"product_conditions_set": [],
"id": "24E3243A15DB48A29289BE3AABA1D19A",
"number_of_conditions": 0
},
{
"time_conditions_set": [
{
"from": 8,
"id": "B783E947B80146369F1BC79FFD7D6E71",
"to": 12
},
{
"from": 14,
"id": "78BD632CC8A44C19A5401DD6CA8E0AB7",
"to": 18
}
],
"date_conditions_set": [
{
"id": "76F866833A924138BCF88496F0834696",
"day_of_week": "THURSDAY"
},
{
"id": "643CAA0FB2B646D3AB56C69229768857",
"day_of_week": "TUESDAY"
},
{
"id": "6CA2F8B04AF3494EA113DD432A127F11",
"day_of_week": "MONDAY"
}
],
"unit_conditions_set": [],
"total_amount": 15,
"product_conditions_set": [
{
"product_family": null,
"product": {
"code": "Gold",
"alternative_code": "G",
"description": null,
"id": "D1EB074DFD904E54A0C67CAB9DC7E010"
},
"product_type": null,
"id": "E33A30EF33CC4064913B0CF88A8F66BF"
},
{
"product_family": null,
"product": {
"code": "Expense 1",
"alternative_code": "E1",
"description": null,
"id": "A9917A7895044BEF9499DD6958539D33"
},
"product_type": null,
"id": "1796705B577D4F3283A086DCF9A430CB"
},
{
"product_family": null,
"product": {
"code": "Expense 2",
"alternative_code": "E2",
"description": null,
"id": "1CEB8D2B86134B138469F8F3E12EB792"
},
"product_type": null,
"id": "757B86A5A3A0410B9227E6DD5F5CF46D"
},
{
"product_family": null,
"product": {
"code": "Movies 1",
"alternative_code": "M1",
"description": null,
"id": "571C10876AF840088372A94A14D0A02C"
},
"product_type": null,
"id": "2CEFAFCB74494A3DA4A9B5E048DB4094"
}
],
"id": "8398F029134F4DEDACE7A95AE7F597FC",
"number_of_conditions": 9
}
],
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"allotments_set": [
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "6FB05162174E4FC8BDB904B69B004EB7"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "BC08DAFE9261479BAA62E05485CA1D67"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "5D50F1925AC443F7A9FCDC1B03F81932"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "06E5AAA2D15340539BA5333CC0C9A7F8"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 0,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "206CD5A6A458435FA5197A08C30817AD"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 2,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "E277B8BB4E6F49FBBFD604F4D16CE207"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "77F30B2C8F8F4B20B3BDF9DFD5416EB6"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "31D00370BD54403DA83D149CE66523B1"
},
{
"time_conditions_set": [
{
"from": 10,
"id": "9C6A564EC57E4EB78A59B67A1F71D9DF",
"to": 22
}
],
"date_conditions_set": [
{
"id": "0BB8EB803C55412A971585397649EB0D",
"day_of_week": "WEDNESDAY"
},
{
"id": "6338B7CA578F4156904A03EFA9A24E49",
"day_of_week": "TUESDAY"
},
{
"id": "763ED45F7F614839A14C52AFBA6B74CE",
"day_of_week": "FRIDAY"
},
{
"id": "B28836F4270F46B5AEDC504409DD8241",
"day_of_week": "THURSDAY"
},
{
"id": "C9BAB89E57A646338497E684AB6FB1BC",
"day_of_week": "MONDAY"
}
],
"amount": 20,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "36AF0DFF9F2E4DFDA6248EDE7AC910C9",
"product_conditions_set": [],
"id": "4637B3DE92B24374BA97BCC91CBD5557"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "C05BE65E71814EF8B1F02FF6FD121127"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "6DA68BF4F134416E98D35040D296F207"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "55F5979699BF4B23BB77DC79FACB8F89"
},
{
"time_conditions_set": [
{
"from": 14,
"id": "78BD632CC8A44C19A5401DD6CA8E0AB7",
"to": 18
},
{
"from": 8,
"id": "B783E947B80146369F1BC79FFD7D6E71",
"to": 12
}
],
"date_conditions_set": [
{
"id": "643CAA0FB2B646D3AB56C69229768857",
"day_of_week": "TUESDAY"
},
{
"id": "6CA2F8B04AF3494EA113DD432A127F11",
"day_of_week": "MONDAY"
},
{
"id": "76F866833A924138BCF88496F0834696",
"day_of_week": "THURSDAY"
}
],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "8398F029134F4DEDACE7A95AE7F597FC",
"product_conditions_set": [
{
"product_family": null,
"product": {
"code": "Gold",
"alternative_code": "G",
"description": null,
"id": "D1EB074DFD904E54A0C67CAB9DC7E010"
},
"product_type": null,
"id": "E33A30EF33CC4064913B0CF88A8F66BF"
},
{
"product_family": null,
"product": {
"code": "Expense 1",
"alternative_code": "E1",
"description": null,
"id": "A9917A7895044BEF9499DD6958539D33"
},
"product_type": null,
"id": "1796705B577D4F3283A086DCF9A430CB"
},
{
"product_family": null,
"product": {
"code": "Expense 2",
"alternative_code": "E2",
"description": null,
"id": "1CEB8D2B86134B138469F8F3E12EB792"
},
"product_type": null,
"id": "757B86A5A3A0410B9227E6DD5F5CF46D"
},
{
"product_family": null,
"product": {
"code": "Movies 1",
"alternative_code": "M1",
"description": null,
"id": "571C10876AF840088372A94A14D0A02C"
},
"product_type": null,
"id": "2CEFAFCB74494A3DA4A9B5E048DB4094"
}
],
"id": "1DD1BB165EBD486D80EA590BBAE16D44"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "06514132582C43B68FD8AC31F4AE1A63"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "377595B925C8427AA51F741AD08D8FF1"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "C0B15E18B61B41E58379BB5E201BC51B"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "0D5C6F4929924581B14BD21A8DFE39A6"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 2,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "0A914FA903814E6AA89062293006059D"
},
{
"time_conditions_set": [
{
"from": 8,
"id": "B783E947B80146369F1BC79FFD7D6E71",
"to": 12
},
{
"from": 14,
"id": "78BD632CC8A44C19A5401DD6CA8E0AB7",
"to": 18
}
],
"date_conditions_set": [
{
"id": "643CAA0FB2B646D3AB56C69229768857",
"day_of_week": "TUESDAY"
},
{
"id": "6CA2F8B04AF3494EA113DD432A127F11",
"day_of_week": "MONDAY"
},
{
"id": "76F866833A924138BCF88496F0834696",
"day_of_week": "THURSDAY"
}
],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "8398F029134F4DEDACE7A95AE7F597FC",
"product_conditions_set": [
{
"product_family": null,
"product": {
"code": "Movies 1",
"alternative_code": "M1",
"description": null,
"id": "571C10876AF840088372A94A14D0A02C"
},
"product_type": null,
"id": "2CEFAFCB74494A3DA4A9B5E048DB4094"
},
{
"product_family": null,
"product": {
"code": "Gold",
"alternative_code": "G",
"description": null,
"id": "D1EB074DFD904E54A0C67CAB9DC7E010"
},
"product_type": null,
"id": "E33A30EF33CC4064913B0CF88A8F66BF"
},
{
"product_family": null,
"product": {
"code": "Expense 2",
"alternative_code": "E2",
"description": null,
"id": "1CEB8D2B86134B138469F8F3E12EB792"
},
"product_type": null,
"id": "757B86A5A3A0410B9227E6DD5F5CF46D"
},
{
"product_family": null,
"product": {
"code": "Expense 1",
"alternative_code": "E1",
"description": null,
"id": "A9917A7895044BEF9499DD6958539D33"
},
"product_type": null,
"id": "1796705B577D4F3283A086DCF9A430CB"
}
],
"id": "5F43A5EF9D874CCD9DD089CBABBBDF37"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "650E1954B641460A925A6076B17B2A18"
},
{
"time_conditions_set": [
{
"from": 14,
"id": "78BD632CC8A44C19A5401DD6CA8E0AB7",
"to": 18
},
{
"from": 8,
"id": "B783E947B80146369F1BC79FFD7D6E71",
"to": 12
}
],
"date_conditions_set": [
{
"id": "6CA2F8B04AF3494EA113DD432A127F11",
"day_of_week": "MONDAY"
},
{
"id": "643CAA0FB2B646D3AB56C69229768857",
"day_of_week": "TUESDAY"
},
{
"id": "76F866833A924138BCF88496F0834696",
"day_of_week": "THURSDAY"
}
],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "8398F029134F4DEDACE7A95AE7F597FC",
"product_conditions_set": [
{
"product_family": null,
"product": {
"code": "Expense 2",
"alternative_code": "E2",
"description": null,
"id": "1CEB8D2B86134B138469F8F3E12EB792"
},
"product_type": null,
"id": "757B86A5A3A0410B9227E6DD5F5CF46D"
},
{
"product_family": null,
"product": {
"code": "Expense 1",
"alternative_code": "E1",
"description": null,
"id": "A9917A7895044BEF9499DD6958539D33"
},
"product_type": null,
"id": "1796705B577D4F3283A086DCF9A430CB"
},
{
"product_family": null,
"product": {
"code": "Movies 1",
"alternative_code": "M1",
"description": null,
"id": "571C10876AF840088372A94A14D0A02C"
},
"product_type": null,
"id": "2CEFAFCB74494A3DA4A9B5E048DB4094"
},
{
"product_family": null,
"product": {
"code": "Gold",
"alternative_code": "G",
"description": null,
"id": "D1EB074DFD904E54A0C67CAB9DC7E010"
},
"product_type": null,
"id": "E33A30EF33CC4064913B0CF88A8F66BF"
}
],
"id": "BD4FC9E4EB6941858E44FE08E19BBBB4"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 2,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "E998FADD01C541A98790B3A4D28993EC"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "CCDCCFC47B6B456F8361F919EFB73BD1"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "CB498CC98983490B8CA91E320D8C3E7A"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 5,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "14047FDA8998472289202E719B793CAF"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 3500,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "D3A9E0EED272457FA1AFCFB6CAD6CE89"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 2,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "61BE52F11C7340BC82C1741956471890"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": -10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "5CE14F43496440C98A08968E3C2D63DF"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "E6890F9B439B4CD48E45FE9EEE172C2D"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 10,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "4A9CB59D954643EA9F0E8AA937423A7A"
},
{
"time_conditions_set": [],
"date_conditions_set": [],
"amount": 2,
"unit_conditions_set": [],
"validity_date": null,
"group_condition_id": "24E3243A15DB48A29289BE3AABA1D19A",
"product_conditions_set": [],
"id": "B6B40D5080E9485A917687C5E0530BCD"
}
]
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET wallets/transactions/get_latest
This method is used to get the latest wallet transactions of a specific wallet.
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:
| ||||||||||||
wallet_transaction_type_identifier | Wallet Transaction Type identifier | The wallet transactions type of the wallet transactions that should be retrieved in the results. The allowed wallet transaction type identifier fields are the following:
| ||||||||||||
| number (mandatory) | 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
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"notes": null,
"extra_added_amount": null,
"amount": 201,
"wallet":
{
"accounts_receivable":
{
"account_owner": null,
"life_cycle_state": null,
"number": "1",
"name": "temp1",
"id": "7EADD42E096822351A97B1AF267F9313"
},
"number": "1",
"id": "CD29B10349C427F28E783F6CAB804F3D"
},
"number": "17",
"type":
{
"classification": "CREDIT",
"name": "Normal Credit",
"id": "D3E2451E22BEFB0C5E0BEC677AF9A7B2",
"description": null,
"alternative_code": "NC"
},
"id": "A5CB03FC1B48EB6103B6AECDC1C88DCA"
},
{
"notes": null,
"extra_added_amount": null,
"amount": 100.64,
"wallet":
{
"accounts_receivable":
{
"account_owner": null,
"life_cycle_state": null,
"number": "1",
"name": "temp1",
"id": "7EADD42E096822351A97B1AF267F9313"
},
"number": "1",
"id": "CD29B10349C427F28E783F6CAB804F3D"
},
"number": "16",
"type":
{
"classification": "CREDIT",
"name": "Normal Credit",
"id": "D3E2451E22BEFB0C5E0BEC677AF9A7B2",
"description": null,
"alternative_code": "NC"
},
"id": "D7B95D9BD37D7456D5FC17CC996EBE93"
}
]
}
GET wallets/get_product_available_amount
This method is used to get the amount which is available for specific products for a specific period of time and a specific unit or group
Available from CRM.COM R5.0.0
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:
| ||||||||||||
product_identifier | Product Identifier | The product for which the amount will be calculated for . The allowed product identifier fields are the following:
| ||||||||||||
unit_identifier (semi-optional) | Unit identifier | The unit for which the amount will be calculated for. The allowed unit identifier fields are the following:
| ||||||||||||
group_identifier (semi-optional) | Group identifier | The group for which the amount will be calculated for. The allowed group identifier fields are the following:
| ||||||||||||
as_of_date (mandatory) | Date field | The date for which the amount will be calculated for. | ||||||||||||
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
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"unit": null,
"amount": 0,
"as_of_date": "Sat Jul 05 15:49:59 EEST 2014",
"group":
{
"community_name": "Main Community",
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "3Play ",
"id": "92F0AFC840E91633C5212162303BE8DF",
"description": "3Play Packages (Gold, Silver etc)",
"alternative_code": "3PLAY"
},
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
}
}
}
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"unit": null,
"amount": 0,
"as_of_date": "Sat Jul 05 15:49:59 EEST 2014",
"group":
{
"community_name": "Main Community",
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"product":
{
"product_type":
{
"physical_good_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "3Play ",
"id": "92F0AFC840E91633C5212162303BE8DF",
"description": "3Play Packages (Gold, Silver etc)",
"alternative_code": "3PLAY"
},
"id": "F43EBDCE48CAADEC32CB26F59904ECCD",
"description": "Smart Card",
"code": "Smart Card",
"alternative_code": null
}
}
}
POST wallets/get_effective
This method returns information related with the effective wallet which is related with a specific accounts receivable or rewards participant. A single wallet is returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant identifier | The identifier of the rewards participant related with the effective wallet that should be retrieved as a result. The allowed rewards participant identifier fields are the following:
| ||||||||||||||||||||||||||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the accounts receivable related with the effective wallet that should be retrieved as a result. The allowed accounts receivable 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: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000007"},
"fields_set":"accounts_receivable,balance,currency,id,life_cycle_state,number"
}
Response:
{
"data": {
"number": "W0000000026",
"balance": 2919,
"accounts_receivable": {
"number": "ACR0000000007",
"name": "ACR0000000007 Mary Keller",
"id": "10A149D60365488AB53DCB889CFD98F8",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Mary Keller",
"last_name": "Keller",
"id": "64F72AE24DF644E6A9C2C21A3E397B67",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": "346346",
"type": "PERSON",
"first_name": "Mary",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "252365221",
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"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
}
}
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "A69C2273A76046F5AF90F3EC99824195",
"life_cycle_state": "EFFECTIVE"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST wallets/create
This method creates a wallet. Single wallet can be created by each call.
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
accounts_receivable_identifier | Account Receivable identifier | The identifier of the account receivable related with the wallet that should be created. The allowed accounts receivable identifier fields are the following:
| |||||||||
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 | |||||||||
(optional) | Set of Wallet Product Consumption Objects | The information related with the consumption of the wallet amount by various products | |||||||||
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 |
Referred Objects Response Data
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: POST
Request:
Body:
{
"token":"1A24F5E323FD11FCD9961F0B8211FAFA",
"accounts_receivable_identifier":{"number":"401"},
"udf_string_1":"udf string 1",
"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_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"product_consumption_set":
[
{
"product_identifier":{"code":"FEE8"},
"estimated_consumption_date":"2014-09-08T09:00:00",
"estimated_consumption_as_of_date":"2014-09-08T09:00:00"
},
{
"product_identifier":{"code":"FEE9"},
"estimated_consumption_date":"2014-10-08T09:00:00",
"estimated_consumption_as_of_date":"2014-10-18T09:00:00"
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": "6",
"udf_float_4": 40,
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"estimated_consumption_as_of_date": null,
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "401",
"name": "Loucia Papapavlou",
"id": "ACAED91501DC6856A93E1E7E5AF6E5C0"
},
"id": "16293AD8F790A2EFA050E30C7FB6DB8A",
"balance": 0,
"estimated_consumption_days": null,
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"product_consumptions_set":
[
{
"estimated_date": "2014-10-08T09:00:00",
"estimated_days": -10,
"id": "7E83F7B7D807E098850CEDA2980BF4D7",
"estimated_as_of_date": "2014-10-18T09:00:00",
"product":
{
"product_type": null,
"id": "BA96B8FE1299C4F364CA8EF3D7F1FC17",
"description": "FEE9",
"code": "FEE9",
"alternative_code": null
}
},
{
"estimated_date": "2014-09-08T09:00:00",
"estimated_days": 0,
"id": "4A266612CFAB6B6E6391C9A9581F8E1E",
"estimated_as_of_date": "2014-09-08T09:00:00",
"product":
{
"product_type": null,
"id": "C3709DB6CBF204509A1FFC1C87922CBD",
"description": "FEE8",
"code": "FEE8",
"alternative_code": null
}
}
],
"log_information":
{
"updated_date": "2014-10-31T17:49:34",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-10-31T17:49:33",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"estimated_consumption_date": null,
"life_cycle_state": "EFFECTIVE"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000221"},
"udf_string_1":"udf string 1",
"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_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"product_consumption_set":
[
{
"product_identifier":{"code":"Bronze"},
"estimated_consumption_date":"2014-09-08T09:00:00",
"estimated_consumption_as_of_date":"2014-09-08T09:00:00"
}
]
}
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:16:54",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
}
},
"udf_date_2": "2014-06-05T15:49:59",
"product_consumption_set": [
{
"estimated_consumption_days": -666,
"product": {
"code": "Bronze",
"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": "B",
"description": null,
"id": "F50CC52934BD4F119B6E18E215A4FC55"
},
"estimated_consumption_as_of_date": "2014-09-08T09:00:00",
"estimated_consumption_date": "2014-09-08T09:00:00",
"id": "7033D498B4AF4CC09091164703DA5A85"
}
],
"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": "2014-09-08T09:00:00",
"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": "udf string 1",
"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": "EFFECTIVE",
"estimated_consumption_days": -666,
"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": "udf string 8",
"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": ""
}
}
POST wallets/update
This method updates a wallet. Single wallet can be updated 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 to be updated. The allowed wallet identifier fields are the following:
| |||||||||
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 | |||||||||
| product_consumption_set | Set of Wallet Consumption Objects | The information related with the consumption of the wallet amount by various products If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| |||||||||
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 |
Referred Objects Response Data
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: POST
Request:
Body:
{
"token":"06A278ADF70A9571B39C63821E39F45A",
"wallet_identifier":{"number":"13"},
"udf_string_1":"TEST",
"udf_string_8":"NEWTEST",
"product_consumption_set": [
{
"action": "update",
"wallet_product_consumption_identifier":{"product_identifier" : { "code" : "OTP002"}}
},
{
"action": "remove",
"wallet_product_consumption_identifier":{"product_identifier" : { "code" : "OTP003"}}
},
{
"action": "add",
"product_identifier" : { "code" : "OTP001" }
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"est_consumption_as_of_date": "2014-09-08T09:00:00",
"udf_float_1": 9,
"udf_float_2": null,
"udf_float_3": null,
"number": "13",
"udf_float_4": null,
"udf_string_1": "TEST",
"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": "NEWTEST",
"est_consumption_days": 12,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Michael",
"middle_name": "Costa",
"company_profile": null,
"type": "PERSON",
"first_name": "Marios",
"name": "Marios Michael",
"id": "43443DE5FACC4044291226195EBC0D6C",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country":
{
"name": "CYPRUS",
"id": "181"
},
"passport_number": "2222222",
"social_security_number": "3333333",
"country_of_residence":
{
"name": "CYPRUS",
"id": "181"
},
"industry_sector":
{
"name": "test1",
"id": "623370176793070A4D31FAC5C6F2C63C"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1980
},
"name_day":
{
"month": 1,
"day": 1
},
"id_number": "11111111",
"id_issued_by_country":
{
"name": "CYPRUS",
"id": "181"
},
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "344",
"name": "MariosTest",
"id": "E7C41C86B515359498AB8593773B960A"
},
"id": "4173A4711EB7183A52BB9C66B5240F91",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"product_consumptions_set":
[
{
"estimated_date": null,
"estimated_days": null,
"id": "0A8D8FF90D890DF07A0A5B1F34057A94",
"estimated_as_of_date": null,
"daily_amount": null,
"available_amount": null,
"product":
{
"product_type": null,
"id": "891E24F7F1C8C79A1E179B670680E611",
"description": null,
"code": "OTP001",
"alternative_code": "OTP001"
}
},
{
"estimated_date": null,
"estimated_days": null,
"id": "CDFBAB5FC713490E2A55CAD6B38F15E3",
"estimated_as_of_date": null,
"daily_amount": null,
"available_amount": null,
"product":
{
"product_type": null,
"id": "9485FC0F5C75279E4E8E1FF3B7B247AE",
"description": null,
"code": "OTP002",
"alternative_code": "OTP002"
}
}
],
"udf_date_4": null,
"est_consumption_date": "2014-09-08T09:00:00",
"log_information":
{
"updated_date": "2014-08-26T15:53:29",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-08-26T15:32:33",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"life_cycle_state": "EFFECTIVE"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"wallet_identifier": {"number":"W0000000239"},
"udf_string_1":"TEST",
"udf_string_8":"NEWTEST",
"product_consumption_set": [
{
"action": "remove",
"wallet_product_consumption_identifier":{"product_identifier" : { "code" : "Bronze"}}
},
{
"action": "add",
"product_identifier" : { "code" : "Gold" }
}
]
}
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:24:11",
"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"
},
{
"estimated_consumption_days": -666,
"product": {
"code": "Bronze",
"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": "B",
"description": null,
"id": "F50CC52934BD4F119B6E18E215A4FC55"
},
"estimated_consumption_as_of_date": "2014-09-08T09:00:00",
"estimated_consumption_date": "2014-09-08T09:00:00",
"id": "7033D498B4AF4CC09091164703DA5A85"
}
],
"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": "2014-09-08T09:00:00",
"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": "EFFECTIVE",
"estimated_consumption_days": -666,
"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": ""
}
}
POST wallets/cancel
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": ""
}
}
POST wallets/get_expiring_balance
This method returns information related with the wallet balance that expires before a specified threshold date. The expiring balance 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 (semi-optional) | Wallet Identifier | The identifier of the wallet that should be returned in the results. The allowed wallet identifier fields are the following:
| ||||||||||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant owning the wallet that should be returned in the results. The allowed rewards participant identifier fields are the following:
| ||||||||||||||||||||||||||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable owning the wallet that should be returned in the results. The allowed accounts receivable identifier fields are the following:
| ||||||||||||||||||||||||||||||
threshold_date (mandatory) | Date | The expiration period in days. Only wallet balance that expires on a date which is equal or before the threshold date will be retrieved | ||||||||||||||||||||||||||||||
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 |
|---|---|---|
balance | String | The total amount available in the wallet |
expired_amount | Number | The wallet amount in wallet currency that will be expired on the specified threshold date |
| expired_alternative_amount | Number | The wallet amount in wallet alternative currency that will be expired on the specified threshold date |
| remaining_amount | Number | The wallet amount in wallet currency that will remain after the expiration of the wallet amount |
| remaining_alternative_amount | Number | The wallet amount in wallet alternative currency that will remain after the expiration of the wallet amount |
| currency | Currency Object | The wallet's currency |
| alternative_currency | Currency Object | The wallet's alternative currency |
| expired_amount_per_day_set | Set ow Wallet Expired Amount per Day Objects | The amount that will be expired on each day up to the specified threshold date |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"101F9468E78B4CDB91716A60D3DFC5C8",
"wallet_identifier":{"number":"W0000000755"},
"threshold_date":"2016-10-30T14:00:59"
}
Response:
{
"data":
{
"balance": 38,
"expired_amount": 18,
"remaining_amount": 20,
"currency":
{
"suffix_symbol": "N/A",
"prefix_symbol": "\u20ac",
"decimal_part_name": "cents",
"code": "EUR",
"integer_part_name": "euro",
"id": "2"
}
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}
POST wallets/get_balance
This method returns information related with the balance of the wallet which is available either on the current date or as of a date in the future. The balance 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 (semi-optional) | Wallet Identifier | The identifier of the wallet that should be returned in the results. The allowed wallet identifier fields are the following:
| ||||||||||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant owning the wallet that should be returned in the results. The allowed rewards participant identifier fields are the following:
| ||||||||||||||||||||||||||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable owning the wallet that should be returned in the results. The allowed accounts receivable identifier fields are the following:
| ||||||||||||||||||||||||||||||
as_of_date (optional) | Date | The date as of which the wallet balance will be calculated (inclusive). If specified then this date should be in the future. If not specified then the current date is used | ||||||||||||||||||||||||||||||
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 |
| balance | Number | The total balance of the retrieved wallet in wallet currency |
| alternative_balance | Number | The total balance of the retrieved wallet in its alternative currency Available in CRM.COM R14.2.0 |
| conditional_balance | Number | The total conditional balance of the retrieved wallet in wallet currency Available in CRM.COM R15.0.0 |
| conditional_alternative_balance | Number | The total conditional balance of the retrieved wallet in wallet alternative currency Available in CRM.COM R15.0.0 |
| unconditional_balance | Number | The total unconditional balance of the retrieved wallet in wallet currency Available in CRM.COM R15.0.0 |
| unconditional_alternative_balance | Number | The total unconditional balance of the retrieved wallet in wallet alternative currency Available in CRM.COM R15.0.0 |
| currency | Currency Object | The wallet's currency |
| alternative_currency | Currency Object | The wallet's alternative currency Available in CRM.COM R14.2.0 |
| remaining_wallet_transaction_limits | Remaining Wallet Transaction Limits Object | The remaining allowed amount for the retrieved wallet's transactions. Remaining wallet transaction limits are available only in the wallet's primary currency. Available in CRM.COM R15.0.0 |
| 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: POST
Request:
Body:
{
"token":"D3D8429F9C90424C8898D5776EFDDC68",
"wallet_identifier":{"number":"W0000000682"},
"as_of_date":"2017-01-08T14:00:59"
}
Response:
{
"data": {
"balance": 6,
"allotment_group_conditions_set": [
{
"time_conditions_set": [],
"date_conditions_set": [],
"unit_conditions_set": [],
"total_amount": 0,
"product_conditions_set": [],
"id": "1858C790DD4E4999916D6C0BF63D8A8B",
"number_of_conditions": 0
},
{
"time_conditions_set": [],
"date_conditions_set": [
{
"id": "9C9CE920101F4C34B48D0EAE5ACD03D1",
"day_of_week": "THURSDAY"
},
{
"id": "55D0E56851034822999DDB64621DC629",
"day_of_week": "FRIDAY"
},
{
"id": "FEC879A4EA584CD7B96E5D405869407E",
"day_of_week": "SATURDAY"
},
{
"id": "B3B4054B5D7744E4BA95D388CAD187A2",
"day_of_week": "MONDAY"
},
{
"id": "F769CB3077584ECFBE1822276DF864C7",
"day_of_week": "SUNDAY"
},
{
"id": "43C9C18B243740F6B4E3F0EBDABC72F1",
"day_of_week": "WEDNESDAY"
},
{
"id": "E90EA057542D47008495E1E12E21F1B7",
"day_of_week": "TUESDAY"
}
],
"unit_conditions_set": [
{
"unit": null,
"id": "7FB26506F6A54544B774F76164B45E42",
"group": {
"alternative_code": "A",
"community_name": "Internal",
"name": "Addidas",
"description": "Addidas",
"id": "FE1585AE3D954CC4AB956DB656FA847C"
}
}
],
"total_amount": 3,
"product_conditions_set": [
{
"product_family": null,
"product": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"product_type": null,
"id": "EF79FF61BB074D6D841354FA3264B8F9"
}
],
"id": "3B180ADA495B48D6A2F64373113EE5EB",
"number_of_conditions": 9
},
{
"time_conditions_set": [],
"date_conditions_set": [
{
"id": "00AF0669BE14410B965F04C80A973B33",
"day_of_week": "WEDNESDAY"
},
{
"id": "8C8A05A8A5F24356A93AA18291CAFA89",
"day_of_week": "SUNDAY"
},
{
"id": "482E65AB09A8425A99FCD5714EDB14B5",
"day_of_week": "MONDAY"
},
{
"id": "5A11FE46247A404D993D96300A73B78B",
"day_of_week": "THURSDAY"
},
{
"id": "38C8FF27FA4942B2935FB160A0BA63C9",
"day_of_week": "FRIDAY"
},
{
"id": "9BE4EA94DF204524A3A0698A9C49F316",
"day_of_week": "SATURDAY"
},
{
"id": "18F4EDD786E6488FA224795958C0B58D",
"day_of_week": "TUESDAY"
}
],
"unit_conditions_set": [
{
"unit": null,
"id": "6DC0174C7B9D4D239AC7FAD36374953E",
"group": {
"alternative_code": "A",
"community_name": "Internal",
"name": "Addidas",
"description": "Addidas",
"id": "FE1585AE3D954CC4AB956DB656FA847C"
}
}
],
"total_amount": 3,
"product_conditions_set": [],
"id": "F72E65638747455D96A97D67980D05B9",
"number_of_conditions": 8
}
],
"currency": {
"suffix_symbol": "N/A",
"prefix_symbol": "€",
"decimal_part_name": "cents",
"code": "EUR",
"integer_part_name": "euro",
"id": "2"
},
"id": "46B9514E05F140C5B2193BEF103D1FD1"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET wallets/transactions/get_current_balance_period_transactions
Available from CRM.COM R12.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
Examples
HTTP Method: GET
Request:
Body:
Response: