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) | Rewards Participant identifier | 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:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
| accounts_receivable_identifier (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:
| ||||||||||||||||||||||||||||||
| wallet_identifier (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) | Award Reward Transaction identifier | 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) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 | ||||||||||||||||||||||||||||||
offset (optional) | Number | 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 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
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved reward award expiration transaction |
number | String | The number of the retrieved reward award expiration transaction |
| life_cycle_state | String | The life cycle state of the retrieved reward award expiration transaction. The available values are POSTED and CANCELLED |
| amount | Number | The amount of the retrieved reward award expiration transaction in rewards participant currency |
| alternative_amount | Number | The amount of the retrieved reward award expiration transaction in alternative currency Available form CRM.COM R14.2.0 |
| spend_method | String | Defines how the awarded amount could be spent Supported values
Available from CRM.COM R17.9.0 |
| rewards_participant | Rewards Participant Object | The rewards participant whose awarded amount is expired by the retrieved reward award expiration transaction Deprecated from CRM.COM R17.0.0 |
| accounts_receivable | Accounts Receivable Object | The accounts receivable whose awarded amount is expired by the retrieved reward award expiration transaction Available from CRM.COM R17.0.0 |
Log Information object | The log information related with the retrieved job | |
| initiated_currency | Currency Object | The currency in which the reward award expiration transaction was initiated Available form CRM.COM R14.2.0 |
| currency_rate_period | Currency Rate Period Object | The Currency Rate Period of the award expiration transaction Available form CRM.COM R10.0.0 |
| wallet_transactions_set | Set of Wallet Transaction objects | The debit wallet transactions that were generated by the award expiration transaction |
| award_rewards_transactions_set | Set of Award Reward Transaction | A list of reward award transactions which are expired through the retrieved award expiration transaction |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"EAE8C0B89D2C412AA5D26CB2477DAB16",
"wallet_identifier":{"number":"W0000000264"},
}
Response:
{
"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": ""
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000050"}
}
Response:
{
"data": [
{
"number": "1",
"amount": 5.6,
"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-19T06:40:12",
"updated_date": "2016-07-19T06:40:12",
"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": "F50E0C6DE5B94C78AF3B1CEBB9F2F0F9",
"life_cycle_state": "POSTED",
"award_rewards_transactions_set": [
{
"number": "1192",
"amount": 5.6,
"id": "3BBA275F9B7644D9B9EBB30F3A6291A5",
"life_cycle_state": "POSTED",
"rewards_participant": {
"number": "RP0000000050",
"accounts_receivable": {
"number": "ACR0000000265",
"name": "ACR0000000265 Maria Roberts",
"id": "CA846B39264747288785DABD4734D03D",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Roberts",
"id": "A6702F8267824E77AE3E09D2AC8B8649",
"life_cycle_state": "FINANCIAL",
"middle_name": "Emilia",
"title": "Sir",
"type": "PERSON",
"first_name": "Maria",
"demographics": {
"name_day": {
"month": 8,
"day": 18
},
"id_number": "MER000123",
"gender": "FEMALE",
"date_of_birth": {
"month": 5,
"year": 1981,
"day": 12
},
"passport_number": "MER000123",
"social_security_number": "MER000123"
}
}
},
"id": "75FBD14F08AC4E88AE7756CFA93796D1"
}
}
],
"wallet_transactions_set": [
{
"number": "1687",
"amount": 0.0000000000005897504706808832,
"notes": null,
"wallet": {
"number": "W0000000231",
"accounts_receivable": {
"number": "ACR0000000265",
"name": "ACR0000000265 Maria Roberts",
"id": "CA846B39264747288785DABD4734D03D",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Roberts",
"id": "A6702F8267824E77AE3E09D2AC8B8649",
"life_cycle_state": "FINANCIAL",
"middle_name": "Emilia",
"title": "Sir",
"type": "PERSON",
"first_name": "Maria",
"demographics": {
"name_day": {
"month": 8,
"day": 18
},
"id_number": "MER000123",
"gender": "FEMALE",
"date_of_birth": {
"month": 5,
"year": 1981,
"day": 12
},
"passport_number": "MER000123",
"social_security_number": "MER000123"
}
}
},
"id": "FBAC7E8FAA23406D8BC6411E961AE1D8",
"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-19T06:40:13",
"updated_date": "2016-07-19T06:40:13",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"id": "C7787AB3C9F8452D9AAC892711336178",
"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": "RP0000000050",
"accounts_receivable": {
"number": "ACR0000000265",
"name": "ACR0000000265 Maria Roberts",
"id": "CA846B39264747288785DABD4734D03D",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Maria Roberts",
"last_name": "Roberts",
"id": "A6702F8267824E77AE3E09D2AC8B8649",
"life_cycle_state": "FINANCIAL",
"middle_name": "Emilia",
"title": "Sir",
"type": "PERSON",
"first_name": "Maria",
"demographics": {
"name_day": {
"month": 8,
"day": 18
},
"id_number": "MER000123",
"gender": "FEMALE",
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": 5,
"year": 1981,
"day": 12
},
"industry_sector": {
"alternative_code": "FIN",
"name": "FINANCIALS",
"id": "61FD1DE51A932732C059FE9CFB6B38B3"
},
"passport_number": "MER000123",
"industry": {
"code": "M",
"name": "Marketing",
"id": "4E943D0C064965D970A294D32A05201C"
},
"social_security_number": "MER000123",
"id_issued_by_country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"passport_issued_by_country": {
"alternative_code": "GRC",
"three_character_code": "GRE",
"name": "GREECE",
"id": "209",
"two_character_code": "GR"
}
}
}
},
"id": "75FBD14F08AC4E88AE7756CFA93796D1"
}
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}