| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET reward_transactions/awards/show
This method returns information related with a reward award transaction. A single rewards awards transaction is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
reward_award_transaction_identifier
(semi-optional)
...
The identifier of the reward award transaction that should be returned as a result. The allowed reward award transaction identifier fields are the following:
...
| Tip |
|---|
For releases prior to CRM.COM R10.1.0 this information is mandatory |
...
(semi-optional)
...
Wallet Transaction identifier
The identifier of the wallet transaction related with the reward award transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
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
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
POST reward_transactions/awards/list
This method returns information related with reward award transactions. Multiple reward award transactions are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
rewards_participant_identifier
(semi-optional)
...
The identifier of the rewards participant whose reward award transactions should be returned as a results. The allowed rewards participant identifier fields are the following:
...
(semi-optional)
...
Accounts Receivable identifier
The identifier of the accounts receivable related with the rewards participant that should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
(semi-optional)
...
Wallet identifier
The identifier of the reward participant's wallet which was affected by the reward award transactions that should be returned as a result. The allowed wallet identifier fields are the following:
...
purchase_customer_event_identifier
(semi-optional)
...
The identifier of the purchase customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
...
referral_customer_event_identifier
(semi-optional)
...
The identifier of the referral customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
...
social_media_customer_event_identifier
(semi-optional)
...
The identifier of the social media customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
...
web_customer_event_identifier
(semi-optional)
...
The identifier of the web purchase customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
...
achievement_customer_event_identifier
(semi-optional)
...
The identifier of the achievement customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
...
financial_achievement_customer_event_identifier
(semi-optional)
...
The identifier of the financial achievement customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R10.0.0 |
...
submitted_after_date
(optional)
...
If specified then reward award transactions that were submitted after the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
submitted_before_date
(optional)
...
If specified then reward award transactions that were submitted before the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
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
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"33B153AE3857406CA7C9971CAC0BDD7C",
"rewards_participant_identifier":{"number":"20"}
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-01-21T14:58:59",
"created_date": "2015-01-21T14:58:59",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 5,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction":
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 5,
"number": "WT000712",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "CREDIT",
"id": "A1F81D0299D4FB0ADFAD83536B94BF5C",
"name": "Normal Credit 2",
"description": "Normal Credit for Wallets (Testing TC3)",
"alternative_code": "NC2"
},
"id": "20AE6201443EDCC92D777D82782FB5C7"
},
"number": "66",
"id": "8A755C6DFA3CC11434971BFEB575EA84",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "18",
"id": "46D23E5CC75C580F38344528AF67556C",
"name": "5 Euros for New Customers",
"description": "5 Euros for New Customers",
"alternative_code": "5EFNC"
},
"customer_events_set": [],
"expiration_date": null
},
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-02-18T11:47:25",
"created_date": "2015-02-18T11:47:25",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 5,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction":
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 5,
"number": "WT000847",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "CREDIT",
"id": "A1F81D0299D4FB0ADFAD83536B94BF5C",
"name": "Normal Credit 2",
"description": "Normal Credit for Wallets (Testing TC3)",
"alternative_code": "NC2"
},
"id": "87F3EEAC25F24CC4BD7C63553163D4AF"
},
"number": "164",
"id": "BDEF543CAFDA4CBAB6FD197DE18D0744",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "26",
"id": "A121DC8DD4B24A019E7ACEA56A8D960A",
"name": "5 euros on customers with complete email and phone",
"description": "5 euros on customers with complete email and phone",
"alternative_code": "5EOCWCEAP"
},
"customer_events_set": [],
"expiration_date": null
},
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-09-29T14:51:40",
"created_date": "2015-09-29T14:51:40",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 5,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction":
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 5,
"number": "WT001121",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "CREDIT",
"id": "A1F81D0299D4FB0ADFAD83536B94BF5C",
"name": "Normal Credit 2",
"description": "Normal Credit for Wallets (Testing TC3)",
"alternative_code": "NC2"
},
"id": "1400F6DAD76B405A89161204B1C737F0"
},
"number": "189",
"id": "E47D2E5E8BDE4F1DA0DCE53790455FC0",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "17",
"id": "446896EA2FE3EFB226596EEA9603366F",
"name": "5 Euros on customers that had any customer event during December",
"description": "5 Euros on customers that had any customer event during December TC23",
"alternative_code": "5EOCTHACEDD"
},
"customer_events_set": [],
"expiration_date": null
},
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-12-19T12:59:20",
"created_date": "2015-12-07T12:53:47",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 651,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction":
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 651,
"number": "WT001206",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "CREDIT",
"id": "981E56423160D488A58635847A84CAA3",
"name": "Normal Credit",
"description": "normal credit for wallets",
"alternative_code": "NC"
},
"id": "3155E7430BCB4F9D9B41C76407828CFB"
},
"number": "265",
"id": "86E153AA7E914ADB8528B3E31875AF30",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "42",
"id": "B89D5DC72E344F05B685C73D82C2E426",
"name": "Utilise Free Capacity",
"description": null,
"alternative_code": "UFC"
},
"customer_events_set": [
{
"life_cycle_state": "POSTED",
"classification": null,
"number": "296",
"type": "PURCHASE",
"id": "6E32C7570EC440A791AEA97A213CAD0D"
}
],
"expiration_date": null
},
{
"award_expiration_transaction": {
"life_cycle_state": "POSTED",
"amount": 66,
"rewards_participant": {
"accounts_receivable": {
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"number": "13",
"id": "9883732F10654831BB0233A00ED2662F"
},
"log_information": {
"updated_date": "2015-12-19T12:59:19",
"created_date": "2015-12-07T15:43:45",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 66,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction":
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 66,
"number": "WT001292",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "VOID",
"id": "1EE27DC8528083BAF4887DF632D240FA",
"name": "Normal Void",
"description": "Normal Void for Wallets",
"alternative_code": "NV"
},
"id": "29A8CE08ACB44AD399D096BA75AF83FA"
},
{
"notes": null,
"life_cycle_state": "VOIDED",
"extra_added_amount": null,
"amount": 66,
"number": "WT001209",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "CREDIT",
"id": "981E56423160D488A58635847A84CAA3",
"name": "Normal Credit",
"description": "normal credit for wallets",
"alternative_code": "NC"
},
"id": "A926B7A79FC04F99823B90F43959522D"
},
"number": "268",
"id": "2E8007A6FECC40708CCB3ABF8F52B99D",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "42",
"id": "B89D5DC72E344F05B685C73D82C2E426",
"name": "Utilise Free Capacity",
"description": null,
"alternative_code": "UFC"
},
"customer_events_set": [
{
"life_cycle_state": "POSTED",
"classification": null,
"number": "299",
"type": "PURCHASE",
"id": "950A796BE089436EADCE3AD9E840E015"
}
],
"expiration_date": "2015-12-06T00:00:00"
},
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-12-19T12:59:20",
"created_date": "2015-12-17T14:06:36",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 10,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction": {},
"number": "291",
"id": "5ACE8A3D025742F999A8AA7E9211AA4A",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "43",
"id": "86339F52CAC84A6EBF3DA9BA6B8A7403",
"name": "Increase Revenue Product Based",
"description": null,
"alternative_code": "IRPB"
},
"customer_events_set": [
{
"life_cycle_state": "POSTED",
"classification": null,
"number": "337",
"type": "PURCHASE",
"id": "92A03198F6BE41229D2E14F1E2F638D2"
}
],
"expiration_date": "2016-01-17T14:06:36"
},
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-12-19T12:59:20",
"created_date": "2015-12-17T14:06:36",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 110,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction": {},
"number": "292",
"id": "B9E972CE40B44128BBF3DC5B8D8BFB5F",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "42",
"id": "B89D5DC72E344F05B685C73D82C2E426",
"name": "Utilise Free Capacity",
"description": null,
"alternative_code": "UFC"
},
"customer_events_set": [
{
"life_cycle_state": "POSTED",
"classification": null,
"number": "337",
"type": "PURCHASE",
"id": "33888D18582C4B9CB5BCF88E7674D3A9"
}
],
"expiration_date": "2015-12-06T00:00:00"
},
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-12-19T12:59:20",
"created_date": "2015-12-17T14:18:20",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 10,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction":
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 10,
"number": "WT001231",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "CREDIT",
"id": "84739C8796344652B9EBEBFA0B4D9255",
"name": "New Credit Type",
"description": null,
"alternative_code": "NCT"
},
"id": "4556E9F6EFBE45D4AFEF0BE996C56248"
},
"number": "293",
"id": "9C72B8FC428F4D7ABF237D545AA858BB",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "43",
"id": "86339F52CAC84A6EBF3DA9BA6B8A7403",
"name": "Increase Revenue Product Based",
"description": null,
"alternative_code": "IRPB"
},
"customer_events_set": [
{
"life_cycle_state": "POSTED",
"classification": null,
"number": "338",
"type": "PURCHASE",
"id": "D3ECAC3DA6B4486F9F3154232CEE7EB3"
}
],
"expiration_date": "2016-01-17T14:18:20"
},
{
"award_expiration_transaction": null,
"log_information": {
"updated_date": "2015-12-19T12:59:20",
"created_date": "2015-12-17T14:18:20",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"amount": 165,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": "Kalvaris Myrias",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "20",
"id": "1A400E0ED18344882D821125CB6FCFBD"
},
"wallet_transaction":
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 165,
"number": "WT001232",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Kalvaris",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Myrias",
"type": "PERSON",
"id": "145037EE049032288366448D8FC1919B",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "123456789",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000401",
"id": "068B2E25D66A8D1572B8E1C039D501C8",
"name": "Myria Kalvari Rewards"
},
"number": "WLT000112",
"id": "31C7907B0190A65ECBA99CDED647C1C1"
},
"type": {
"classification": "CREDIT",
"id": "84739C8796344652B9EBEBFA0B4D9255",
"name": "New Credit Type",
"description": null,
"alternative_code": "NCT"
},
"id": "2B6B2EB6374E44FD9A8E36085C686AB6"
},
"number": "294",
"id": "556E78DFEC0645A6B599B87F11633708",
"reward_offer": {
"life_cycle_state": "NOT_EFFECTIVE",
"number": "42",
"id": "B89D5DC72E344F05B685C73D82C2E426",
"name": "Utilise Free Capacity",
"description": null,
"alternative_code": "UFC"
},
"customer_events_set": [
{
"life_cycle_state": "POSTED",
"classification": null,
"number": "338",
"type": "PURCHASE",
"id": "B1F48AF6325A4A09B52F1F9288ED1C7E"
}
],
"expiration_date": "2015-12-06T00:00:00"
}
]
} |
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000057"}
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"number": "1066",
"amount": 10,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-13T14:03:25",
"updated_date": "2016-07-13T14:03:25",
"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"
}
},
"award_expiration_transaction": null,
"reward_offer": {
"number": "22",
"name": "10 Euro award",
"description": null,
"id": "3DE813A206804C1FA1B923750378CA91",
"life_cycle_state": "EFFECTIVE"
},
"currency_rate_period": {
"from_date": "C7D7ED57F21B47028144967E015DCBE5",
"to_date": 2.3,
"rate": 2.3,
"inverse_rate": 0.23000000417232513,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "C7D7ED57F21B47028144967E015DCBE5"
},
"id": "73B1C352F6B54C368296E1E2ED13C125",
"life_cycle_state": "POSTED",
"expiration_date": null,
"wallet_transaction":
{
"number": "1459",
"amount": 10,
"notes": null,
"wallet": {
"number": "W0000000255",
"accounts_receivable": {
"number": "ACR0000000288",
"name": "ACR0000000288 Katerina Nicolaou-Included address area/city",
"id": "3E3FADF2632C41E7987032CFDFF404DC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Nicolaou-Included address area/city",
"id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Katerina ",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "C9414A525E8645CFAC622524ACA1CF4E",
"life_cycle_state": "EFFECTIVE"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-13T14:03:25",
"updated_date": "2016-07-13T14:03:25",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"id": "A0663AB39A6248FBBC65B5FF8C113D6D",
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"type": {
"alternative_code": "WC",
"name": "Wallet Credit",
"description": "Wallet Credit",
"id": "CA1B3E67E5A6F899512CEFE24E40875B",
"classification": "CREDIT"
}
},
"customer_events_set": [],
"rewards_participant": {
"number": "RP0000000057",
"accounts_receivable": {
"number": "ACR0000000288",
"name": "ACR0000000288 Katerina Nicolaou-Included address area/city",
"id": "3E3FADF2632C41E7987032CFDFF404DC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Katerina Nicolaou-Included address area/city",
"last_name": "Nicolaou-Included address area/city",
"id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Katerina ",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "58AF4E5C1B0F41C59BA3820F5454A768"
}
},
{
"number": "1073",
"amount": 65,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-13T14:03:49",
"updated_date": "2016-07-13T14:03:49",
"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"
}
},
"award_expiration_transaction": null,
"reward_offer": {
"number": "58",
"name": "ET Just Money",
"description": null,
"id": "E8E5733EA0F34804BEE8B823D6C61611",
"life_cycle_state": "EFFECTIVE"
},
"currency_rate_period": null,
"id": "385E17501A7840E3ABA96FEAEA67B1A5",
"life_cycle_state": "POSTED",
"expiration_date": null,
"wallet_transaction":
{
"number": "1467",
"amount": 65,
"notes": null,
"wallet": {
"number": "W0000000255",
"accounts_receivable": {
"number": "ACR0000000288",
"name": "ACR0000000288 Katerina Nicolaou-Included address area/city",
"id": "3E3FADF2632C41E7987032CFDFF404DC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Nicolaou-Included address area/city",
"id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Katerina ",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "C9414A525E8645CFAC622524ACA1CF4E",
"life_cycle_state": "EFFECTIVE"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-13T14:03:49",
"updated_date": "2016-07-13T14:03:49",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"id": "D43A4FB22A8E4401A07B1F644F98D081",
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"type": {
"alternative_code": "WC",
"name": "Wallet Credit",
"description": "Wallet Credit",
"id": "CA1B3E67E5A6F899512CEFE24E40875B",
"classification": "CREDIT"
}
},
"customer_events_set": [],
"rewards_participant": {
"number": "RP0000000057",
"accounts_receivable": {
"number": "ACR0000000288",
"name": "ACR0000000288 Katerina Nicolaou-Included address area/city",
"id": "3E3FADF2632C41E7987032CFDFF404DC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Katerina Nicolaou-Included address area/city",
"last_name": "Nicolaou-Included address area/city",
"id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Katerina ",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "58AF4E5C1B0F41C59BA3820F5454A768"
}
},
{
"number": "1160",
"amount": 8.8,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-13T14:53:34",
"updated_date": "2016-07-13T14:53:34",
"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"
}
},
"award_expiration_transaction": null,
"reward_offer": {
"number": "55",
"name": "ET Reward Loyalty Transaction Amount Based",
"description": null,
"id": "5F9F3B3FBF2C45DCB33A5719FB859A42",
"life_cycle_state": "EFFECTIVE"
},
"currency_rate_period": null,
"id": "70BC70010C31418C9379651BA6A9CFA4",
"life_cycle_state": "POSTED",
"expiration_date": null,
"wallet_transaction":
{
"number": "1554",
"amount": 8.8,
"notes": null,
"wallet": {
"number": "W0000000255",
"accounts_receivable": {
"number": "ACR0000000288",
"name": "ACR0000000288 Katerina Nicolaou-Included address area/city",
"id": "3E3FADF2632C41E7987032CFDFF404DC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Nicolaou-Included address area/city",
"id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Katerina ",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "C9414A525E8645CFAC622524ACA1CF4E",
"life_cycle_state": "EFFECTIVE"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-13T14:53:34",
"updated_date": "2016-07-13T14:53:34",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"id": "9B135689DA6E41AD9B1D60A0C53DBEEB",
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"type": {
"alternative_code": "WC",
"name": "Wallet Credit",
"description": "Wallet Credit",
"id": "CA1B3E67E5A6F899512CEFE24E40875B",
"classification": "CREDIT"
}
},
"customer_events_set": [
{
"number": "334",
"id": "BE6F5F432B454FC3AE5875CAC8B9A607",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "317",
"id": "0E86F1145E8246D0B4CB135278A80D4D",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "303",
"id": "78C0B3EBC52E49928C819B2124C0F3BF",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "304",
"id": "9123EA66215848819D68E9F98333799E",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "330",
"id": "4FEE7A2717A244C198050F440EBEA95B",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "293",
"id": "4A7A09DE8F714BC2883E8D1F23B2F2FE",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "313",
"id": "101FB5257FB44DB5A854E344CD37C6F3",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "287",
"id": "1E0FF86A413B480E83DAB9FAE8FA5760",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "298",
"id": "0002659C0634476B988046C42EA86D50",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
},
{
"number": "309",
"id": "B5A7826093DF4938A01F309C8DF32122",
"life_cycle_state": "POSTED",
"type": "PURCHASE",
"classification": null
}
],
"rewards_participant": {
"number": "RP0000000057",
"accounts_receivable": {
"number": "ACR0000000288",
"name": "ACR0000000288 Katerina Nicolaou-Included address area/city",
"id": "3E3FADF2632C41E7987032CFDFF404DC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Katerina Nicolaou-Included address area/city",
"last_name": "Nicolaou-Included address area/city",
"id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Katerina ",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "58AF4E5C1B0F41C59BA3820F5454A768"
}
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
|
...
| title | Example 3 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"accounts_receivable_identifier":{"id":"268861F901364A1CA23F74F644547DD9"},
"submitted_after_date":"2016-07-01T09:00:12",
"submitted_before_date":"2016-08-01T15:00:12",
"fields_set": "number,log_information"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"number": "998",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-29T13:25:26",
"updated_date": "2016-07-29T13:25:26",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
}
},
{
"number": "1001",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-08-01T09:55:02",
"updated_date": "2016-08-01T09:55:02",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
}
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
GET reward_transactions/awards/get_allocated_spends
| Tip |
|---|
This method returns information related with the spend reward transactions that were allocated against a specific award reward transaction. Multiple spend reward transactions are retrieved by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
reward_award_transaction_identifier
(semi-optional)
...
The identifier of the award reward transaction that should be retrieved. The allowed award reward transaction 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
...
Examples
| Expand | |||||
|---|---|---|---|---|---|
| |||||
HTTP Method: GET
Request:
Response:
|
GET reward_transactions/spend/show
This method returns information related with a reward spend transaction. A single rewards spend transaction is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
reward_spend_transaction_identifier
(semi-optional)
...
The identifier of the reward spend transaction that should be returned as a result. The allowed reward spend transaction identifier fields are the following:
...
| Tip |
|---|
For releases prior to CRM.COM R10.1.0 this information is mandatory |
...
(semi-optional)
...
Wallet Transaction identifier
The identifier of the wallet transaction related with the reward spend transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
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
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request: Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
POST reward_transactions/spend/list
This method returns information related with reward spend transactions. Multiple reward spend transactions are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
rewards_participant_identifier
(semi-optional)
...
The identifier of the rewards participant whose reward spend transactions should be returned as a results. The allowed rewards participant identifier fields are the following:
...
(semi-optional)
...
Accounts Receivable identifier
The identifier of the accounts receivable related with the rewards participant whose spend transactions should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
(semi-optional)
...
Wallet identifier
The identifier of the reward participant's wallet which was affected by the reward spend transactions that should be returned as a result. The allowed wallet identifier fields are the following:
...
customer_event_identifier
(semi-optional)
...
The identifier of the customer event that triggered the creation of the reward spend transaction that should be returned as a result. Only Spend Request Customer Events are allowed to be specified. The allowed customer event identifier fields are the following:
...
submitted_after_date
(optional)
...
If specified then reward spend transactions that were submitted after the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
submitted_before_date
(optional)
...
If specified then reward spend transactions that were submitted before the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
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
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"DA73B7EDA0164826A40C38899ABB4F7D",
"rewards_participant_identifier":{"number":"115"}
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"log_information": {
"updated_date": "2016-05-10T08:45:05",
"created_date": "2016-05-10T08:43:42",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"items_set": [
{
"total_amount": 0,
"id": "BD65600AD1604E96AE4ECB61CF8E8055",
"product": {
"product_type": {
"service_type": "USAGE",
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "78F758444F6B8437F1A27F61D1BE84A5",
"name": "VOD",
"description": "Video on Demand Movies",
"alternative_code": "VOD"
},
"id": "02192DC60AF606C2124118AABCBFAAAA",
"description": "Serendipity",
"code": "Serendipity",
"alternative_code": "SRDP"
}
}
],
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"life_cycle_state": "POSTED",
"amount": 0,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"wallet_transactions_set": [],
"number": "97",
"spend_request_customer_event": {
"classification": null,
"number": "78",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"process_immediately": 1,
"spend_reward_transaction": {
"total_amount": 0,
"life_cycle_state": "POSTED",
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"number": "97",
"net_amount": 0,
"id": "43AAA68C98BC43A2B2ACAF4E5FC79074",
"vat_amount": 0
},
"log_information": {
"updated_date": "2016-05-10T08:43:30",
"created_date": "2016-05-10T08:43:06",
"created_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "POSTED",
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"spend_amount": null,
"type": "SPEND_REQUEST",
"id": "487EFE527CCB4EB481B5B41087F119DB",
"description": null,
"performed_on": "2016-05-10T08:43:06"
},
"id": "43AAA68C98BC43A2B2ACAF4E5FC79074",
"date": "2016-05-10T08:43:06"
},
{
"log_information": {
"updated_date": "2016-05-10T08:48:19",
"created_date": "2016-05-10T08:48:01",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"items_set": [
{
"total_amount": 10,
"id": "7D13217F73784EE5BAC4BB2F44EA7639",
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "4643FB222FAAFD85462514704E199387",
"name": "Drinks",
"description": "Drinks (Used for Rewards)",
"alternative_code": "D_1"
},
"id": "6022FD2873C788C625FB5B379D540DF8",
"description": null,
"code": "Vodka",
"alternative_code": "B4V"
}
}
],
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"life_cycle_state": "POSTED",
"amount": 10,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"wallet_transactions_set": [
{
"notes": null,
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"amount": 10,
"number": "WT002024",
"wallet": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "WLT000351",
"id": "DA1121AE7C6D4B05BB93F53BC2AA26F5"
},
"type": {
"classification": "DEBIT",
"id": "D51DAF63F839B59328000FF64744C406",
"name": "Normal Debit",
"description": "Normal Debit for Wallets",
"alternative_code": "ND"
},
"id": "29BD735244BD49F08C061A279C17FCB2"
}
],
"number": "98",
"spend_request_customer_event": {
"classification": null,
"number": "79",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"process_immediately": 1,
"spend_reward_transaction": {
"total_amount": 10,
"life_cycle_state": "POSTED",
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"number": "98",
"net_amount": 10,
"id": "AA75415097C44101B61DA25E7E0523A7",
"vat_amount": 0
},
"log_information": {
"updated_date": "2016-05-10T08:47:54",
"created_date": "2016-05-10T08:47:34",
"created_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "POSTED",
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"spend_amount": null,
"type": "SPEND_REQUEST",
"id": "7E16E1A6A43B4057BAD59DF1C96BE6BD",
"description": null,
"performed_on": "2016-05-10T08:47:34"
},
"id": "AA75415097C44101B61DA25E7E0523A7",
"date": "2016-05-10T08:47:34"
},
{
"log_information": {
"updated_date": "2016-05-16T11:24:18",
"created_date": "2016-05-16T11:24:18",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"items_set": [
{
"total_amount": 0,
"id": "0F3A5416C5254723AA685560D0C5432B",
"product": {
"product_type": {
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "C195EEFC755F4939BF4B49FEDE7D60AB",
"name": "Software Services",
"description": null,
"alternative_code": "SS_1"
},
"id": "4086912F542B4E59A37EE19373586597",
"description": null,
"code": "Support Software",
"alternative_code": "SUP_CRM"
}
}
],
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"life_cycle_state": "POSTED",
"amount": 0,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"wallet_transactions_set": [],
"number": "110",
"spend_request_customer_event": {
"classification": {
"id": "FCC94778CA214D3D87E5D6D8204975EC",
"name": "Spend Request Classification",
"alternative_code": "SRC"
},
"number": "92",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"process_immediately": 1,
"spend_reward_transaction": {
"total_amount": 0,
"life_cycle_state": "POSTED",
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"number": "110",
"net_amount": 0,
"id": "D30744EA67E9494F8CA85896EC1C1B79",
"vat_amount": 0
},
"log_information": {
"updated_date": "2016-05-16T11:24:18",
"created_date": "2016-05-16T11:24:18",
"created_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "POSTED",
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"spend_amount": null,
"type": "SPEND_REQUEST",
"id": "D35935CF833744E494D1CF9C66EBA795",
"description": null,
"performed_on": "2016-05-10T10:50:59"
},
"id": "D30744EA67E9494F8CA85896EC1C1B79",
"date": "2016-05-10T10:50:59"
},
{
"log_information": {
"updated_date": "2016-05-16T11:26:28",
"created_date": "2016-05-16T11:26:28",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"items_set": [
{
"total_amount": 0,
"id": "647AC99A2611419595F6BA657840A3E3",
"product": {
"product_type": {
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "C195EEFC755F4939BF4B49FEDE7D60AB",
"name": "Software Services",
"description": null,
"alternative_code": "SS_1"
},
"id": "4086912F542B4E59A37EE19373586597",
"description": null,
"code": "Support Software",
"alternative_code": "SUP_CRM"
}
}
],
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"life_cycle_state": "POSTED",
"amount": 0,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"wallet_transactions_set": [],
"number": "111",
"spend_request_customer_event": {
"classification": {
"id": "FCC94778CA214D3D87E5D6D8204975EC",
"name": "Spend Request Classification",
"alternative_code": "SRC"
},
"number": "93",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"process_immediately": 1,
"spend_reward_transaction": {
"total_amount": 0,
"life_cycle_state": "POSTED",
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"number": "111",
"net_amount": 0,
"id": "7A553E1AA6264F718A9D1DAEA3F7C55E",
"vat_amount": 0
},
"log_information": {
"updated_date": "2016-05-16T11:26:28",
"created_date": "2016-05-16T11:26:28",
"created_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "POSTED",
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"spend_amount": null,
"type": "SPEND_REQUEST",
"id": "69F14E18F3624FC0A0BA5C3193563684",
"description": null,
"performed_on": "2016-05-10T10:50:59"
},
"id": "7A553E1AA6264F718A9D1DAEA3F7C55E",
"date": "2016-05-10T10:50:59"
}
]
} |
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000049"}
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"date": "2016-06-27T09:50:23",
"number": "33",
"amount": 10,
"unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"items_set": [
{
"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"
},
"total_amount": 10,
"id": "4926E9DF1C2A4FB690EA51994452752F"
}
],
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-06-27T09:50:35",
"updated_date": "2016-06-27T09:50:35",
"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"
}
},
"currency_rate_period": {
"from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
"to_date": 0.25,
"rate": 0.25,
"inverse_rate": 4,
"currency": {
"suffix_symbol": null,
"prefix_symbol": null,
"decimal_part_name": null,
"code": "FJD",
"integer_part_name": null,
"id": "93"
},
"id": "0EEE31A81A064D97A9873F5676D2F4D9"
},
"id": "E06C24BF43BD40FCBC25E17117371421",
"life_cycle_state": "POSTED",
"spend_request_customer_event": {
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-06-27T09:50:23",
"updated_date": "2016-06-27T09:50:35",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"spend_amount": 10,
"description": null,
"accounts_receivable": {
"number": "ACR0000000264",
"name": "ACR0000000264 Alternative Currency",
"id": "4820A781EFF243DF96DD44487EBA5C74",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Alternative Currency",
"last_name": "Currency",
"id": "E6E1240F3C8C48CE83159DB9AF89284B",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Alternative",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"life_cycle_state": "POSTED",
"type": "SPEND_REQUEST",
"performed_on": "2016-06-27T09:50:23",
"classification": null,
"process_immediately": 1,
"spend_reward_transaction": {
"number": "33",
"vat_amount": 0,
"total_amount": 10,
"id": "E06C24BF43BD40FCBC25E17117371421",
"net_amount": 10,
"life_cycle_state": "POSTED",
"rewards_participant": {
"number": "RP0000000049",
"accounts_receivable": {
"number": "ACR0000000264",
"name": "ACR0000000264 Alternative Currency",
"id": "4820A781EFF243DF96DD44487EBA5C74",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Alternative Currency",
"last_name": "Currency",
"id": "E6E1240F3C8C48CE83159DB9AF89284B",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Alternative",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "A1A759EB9A344F8A95D20567F9362296"
}
},
"number": "46",
"id": "D4440626D1C94AAE975DBB62D0AF4EFF",
"performed_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
}
},
"wallet_transactions_set": [
{
"number": "464",
"amount": 10,
"notes": null,
"wallet": {
"number": "W0000000230",
"accounts_receivable": {
"number": "ACR0000000264",
"name": "ACR0000000264 Alternative Currency",
"id": "4820A781EFF243DF96DD44487EBA5C74",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Currency",
"id": "E6E1240F3C8C48CE83159DB9AF89284B",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Alternative",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "C25BB91D35E04332849FD83B94FCF5AE",
"life_cycle_state": "EFFECTIVE"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-06-27T09:50:35",
"updated_date": "2016-06-27T09:50:35",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"id": "ACE6C032A41244B18E9DAE7BEBBC3115",
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"type": {
"alternative_code": "WD",
"name": "Wallet Debit",
"description": "Wallet Debit",
"id": "486825E44D9452107C8EE6AAC6C57884",
"classification": "DEBIT"
}
}
],
"rewards_participant": {
"number": "RP0000000049",
"accounts_receivable": {
"number": "ACR0000000264",
"name": "ACR0000000264 Alternative Currency",
"id": "4820A781EFF243DF96DD44487EBA5C74",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Currency",
"id": "E6E1240F3C8C48CE83159DB9AF89284B",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Alternative",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "A1A759EB9A344F8A95D20567F9362296"
}
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
...
| title | Example 3 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000304"},
"submitted_after_date":"2016-09-14T18:00:12",
"submitted_before_date":"2016-11-03T15:00:12",
"fields_set": "number,date"
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"date": "2016-09-15T17:54:16",
"number": "196"
},
{
"date": "2016-09-20T15:29:25",
"number": "200"
},
{
"date": "2016-09-15T17:49:28",
"number": "194"
},
{
"date": "2016-09-15T17:54:48",
"number": "197"
},
{
"date": "2016-09-15T17:51:32",
"number": "195"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
GET reward_transactions/spend/get_allocated_awards
| Tip |
|---|
This method returns information related with the award reward transactions that were allocated against a specific spend reward transaction. Multiple award reward transactions are retrieved by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
reward_spend_transaction_identifier
(semi-optional)
...
The identifier of the spend reward transaction that should be retrieved. The allowed spend reward transaction 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
...
Examples
| Expand | |||||
|---|---|---|---|---|---|
| |||||
HTTP Method: GET
Request:
Response:
|
GET reward_transactions/award_expiration/show
This method returns information related with a reward award expiration transaction. A single reward award expiration transaction is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
reward_award_expiration_transaction_identifier
(semi-optional)
...
The identifier of the reward award expiration transaction that should be returned as a result. The allowed reward award expiration transaction identifier fields are the following:
...
| Tip |
|---|
For releases prior to CRM.COM R10.1.0 this information is mandatory |
...
(semi-optional)
...
Wallet Transaction identifier
The identifier of the wallet transaction related with the reward award expiration transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
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
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request: Response:
|
POST reward_transactions/award_expiration/list
This method returns information related with reward award expiration transactions. Multiple reward award expiration transactions are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
rewards_participant_identifier
(semi-optional)
...
The identifier of the rewards participant whose reward award expiration transactions should be returned as a results. The allowed rewards participant identifier fields are the following:
...
(semi-optional)
...
Accounts Receivable identifier
The identifier of the accounts receivable related with the rewards participant whose reward award expiration transactions should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
(semi-optional)
...
Wallet identifier
The identifier of the reward participant's wallet which was affected by the reward award expiration transactions that should be returned as a result. The allowed wallet identifier fields are the following:
...
award_reward_transaction_identifier
(semi-optional)
...
The identifier of the reward award transaction which was expired by the reward award expiration transaction that should be returned as a result. The allowed award reward transaction identifier fields are the following:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
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
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"EAE8C0B89D2C412AA5D26CB2477DAB16",
"wallet_identifier":{"number":"W0000000264"},
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"number": "1",
"amount": 2,
"wallet_transactions_set": [
{
"number": "915",
"amount": 2,
"notes": null,
"wallet": {
"number": "W0000000264",
"accounts_receivable": {
"number": "ACR0000000300",
"name": "ACR0000000300 Nelly Malcolm",
"id": "EA6D4489FDB14DD38F4F556D2EAD629B",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Malcolm",
"id": "D162048E241E40B0BEF48A13F58ADA21",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Nelly",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "7B3EE9398ABE4693ADD1881B99EE8171",
"life_cycle_state": "EFFECTIVE"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-18T00:08:47",
"updated_date": "2016-07-18T00:08:47",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"caused_by_entity": "AWARDEXPIRATIONTRANSACTIONS",
"id": "09B1716DCBF8447D9072C84534605AC6",
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"type": {
"alternative_code": "WD",
"name": "Wallet Debit",
"description": "Wallet Debit",
"id": "486825E44D9452107C8EE6AAC6C57884",
"classification": "DEBIT"
},
"caused_by_entity_id": "28A4D6BE4A2A499EB2FE4E36AC5B861E"
}
],
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-18T00:08:46",
"updated_date": "2016-07-18T00:08:46",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"currency_rate_period": null,
"id": "28A4D6BE4A2A499EB2FE4E36AC5B861E",
"life_cycle_state": "POSTED",
"award_rewards_transactions_set": [
{
"number": "390",
"amount": 2,
"id": "43DF6EF6DBD6478EBF3B068BC7BED150",
"life_cycle_state": "POSTED",
"rewards_participant": {
"number": "RP0000000058",
"accounts_receivable": {
"number": "ACR0000000300",
"name": "ACR0000000300 Nelly Malcolm",
"id": "EA6D4489FDB14DD38F4F556D2EAD629B",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Malcolm",
"id": "D162048E241E40B0BEF48A13F58ADA21",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Nelly",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "22A8D50FAF2140D49486F6DC8D29DB3F"
}
}
],
"rewards_participant": {
"number": "RP0000000058",
"accounts_receivable": {
"number": "ACR0000000300",
"name": "ACR0000000300 Nelly Malcolm",
"id": "EA6D4489FDB14DD38F4F556D2EAD629B",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Nelly Malcolm",
"last_name": "Malcolm",
"id": "D162048E241E40B0BEF48A13F58ADA21",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Nelly",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "22A8D50FAF2140D49486F6DC8D29DB3F"
}
},
{
"number": "2",
"amount": 2,
"wallet_transactions_set": [
{
"number": "916",
"amount": 2,
"notes": null,
"wallet": {
"number": "W0000000264",
"accounts_receivable": {
"number": "ACR0000000300",
"name": "ACR0000000300 Nelly Malcolm",
"id": "EA6D4489FDB14DD38F4F556D2EAD629B",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Malcolm",
"id": "D162048E241E40B0BEF48A13F58ADA21",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Nelly",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "7B3EE9398ABE4693ADD1881B99EE8171",
"life_cycle_state": "EFFECTIVE"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-18T00:08:47",
"updated_date": "2016-07-18T00:08:47",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"caused_by_entity": "AWARDEXPIRATIONTRANSACTIONS",
"id": "E85C59B9BF4F40B6A156EA46445342F1",
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"type": {
"alternative_code": "WD",
"name": "Wallet Debit",
"description": "Wallet Debit",
"id": "486825E44D9452107C8EE6AAC6C57884",
"classification": "DEBIT"
},
"caused_by_entity_id": "71F04481B09E4546BED31F016E722E94"
}
],
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-18T00:08:47",
"updated_date": "2016-07-18T00:08:47",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"currency_rate_period": null,
"id": "71F04481B09E4546BED31F016E722E94",
"life_cycle_state": "POSTED",
"award_rewards_transactions_set": [
{
"number": "392",
"amount": 2,
"id": "4157975FE4A64C278840903B10155EF3",
"life_cycle_state": "POSTED",
"rewards_participant": {
"number": "RP0000000058",
"accounts_receivable": {
"number": "ACR0000000300",
"name": "ACR0000000300 Nelly Malcolm",
"id": "EA6D4489FDB14DD38F4F556D2EAD629B",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Malcolm",
"id": "D162048E241E40B0BEF48A13F58ADA21",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Nelly",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": 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
}
}
},
"id": "22A8D50FAF2140D49486F6DC8D29DB3F"
}
}
],
"rewards_participant": {
"number": "RP0000000058",
"accounts_receivable": {
"number": "ACR0000000300",
"name": "ACR0000000300 Nelly Malcolm",
"id": "EA6D4489FDB14DD38F4F556D2EAD629B",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Nelly Malcolm",
"last_name": "Malcolm",
"id": "D162048E241E40B0BEF48A13F58ADA21",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Nelly",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "22A8D50FAF2140D49486F6DC8D29DB3F"
}
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
|
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000050"}
} |
Response:
| language | js |
|---|
| name | blue |
|---|
| Child pages (Children Display) | ||
|---|---|---|
|