- Created by Former user on Jul 06, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
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.
Available from CRM.COM R10.1.0
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
reward_award_transaction_identifier (semi-optional) | Award Reward Transaction Identifier | 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
Name | Type | Description |
---|---|---|
allocated_amount | Number | The amount that was allocated on the spend reward transaction |
allocation_date | Date | The date that the amount was allocated |
spend_reward_transaction | Spend Reward Transaction Object | The spend reward transaction that the spend amount was allocated on |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved spend reward transaction |
number | String | The number of the retrieved spend reward transaction |
total_amount | Number | The total amount that was spend by the retrieved spend reward transaction |
net_amount | Number | The net amount of the retrieved spend reward transaction |
vat_amount | Number | The VAT amount of the retrieved spend reward transaction |
life_cycle_state | String | The life cycle state of the retrieved spend reward transaction which can be POSTED or CANCELLED |
spend_method | String | Defines how the awarded amount was spent The allowed methods are the following
Available from CRM.COM R17.0.0 |
currency_rate_period | Currency Rate Period Object | The currency rate period of the spend reward transaction Available from CRM.COM R10.0.0 |
accounts_receivable | Accounts Receivable Object | The accounts receivable related with the retrieved spend reward transaction Available from CRM.COM R17.0.0 |
rewards_participant | Reward Participant Object | The rewards participant related with the retrieved spend reward transaction Deprecated from CRM.COM R17.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency rate period |
rate | Number | The exchange rate of the currency rate period |
inverse_rate | Number | The inverse exchange rate of the currency rate period |
from_date | Date | The date from which the exchange rate is valid |
to_date | Date | The date until which the exchange rate is valid |
currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved reward participant |
number | String | The number of the retrieved reward participant |
life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED. Available from CRM.COM R12.0.0 |
accounts_receivable | Accounts receivable object | The accounts receivable owned by the reward participant |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Examples
HTTP Method: GET
Request:
Response:
{ "data": [ { "allocated_amount": 1, "allocation_date": "2016-10-12 16:19:06.0", "spend_reward_transaction": { "date": "2016-10-12T16:18:36", "number": "277", "amount": 1, "unit": { "alternative_code": "A", "name": "Addidas", "description": "Addidas", "id": "F784D4FD19ED4ED99F51AAB113B8C668" }, "wallet_transactions_set": null, "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-10-12T16:19:05", "updated_date": "2016-10-12T16:19:05", "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": "D5AA629679F74D3D80D3D0949BBEE770", "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-10-12T16:18:36", "updated_date": "2016-10-12T16:19:05", "updated_by_user": { "person_name": "MPAdministrator", "id": "1", "email": null, "username": "MPAdministrator" }, "created_by_user": { "person_name": "MPAdministrator", "id": "1", "email": null, "username": "MPAdministrator" } }, "spend_amount": 1, "description": null, "accounts_receivable": { "number": "ACR0000000873", "name": "ACR0000000873 Georgia Wallet", "id": "3BE35D2C3CA04FBE9CC38803386E2466", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": null, "company_name": null, "name": null, "last_name": "Wallet", "id": "B43C0D84A9E04D2BB354561CE79A34FD", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "PERSON", "first_name": "Georgia", "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 } } }, "life_cycle_state": "POSTED", "type": "SPEND_REQUEST", "performed_on": "2016-10-12T16:18:36", "classification": null, "process_immediately": true, "spend_reward_transaction": null, "number": "296", "currency": { "suffix_symbol": "N/A", "prefix_symbol": "\u20ac", "decimal_part_name": "cents", "code": "EUR", "integer_part_name": "euro", "id": "2" }, "id": "7FEEF6505489437AACBD76C7282232E2", "performed_by_unit": { "alternative_code": "A", "name": "Addidas", "description": "Addidas", "id": "F784D4FD19ED4ED99F51AAB113B8C668" } }, "rewards_participant": { "number": "RP0000000405", "accounts_receivable": { "number": "ACR0000000873", "name": "ACR0000000873 Georgia Wallet", "id": "3BE35D2C3CA04FBE9CC38803386E2466", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": null, "company_name": null, "name": null, "last_name": "Wallet", "id": "B43C0D84A9E04D2BB354561CE79A34FD", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "PERSON", "first_name": "Georgia", "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": "24C03CEDC4054FD2A33A2D8776407BD7" } } } ], "status": { "code": "OK", "description": "", "message": "" } }
- No labels