- Created by George Rossides (Unlicensed) , last modified on Sept 09, 2016
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 14 Next »
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log information related with the retrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currency object | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automatic spend settings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking state object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
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 unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| classification | Access Token Classification Object | The classification of the access token Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved classification |
name | String | The name of the retrieved classification |
alternative_code | String | The alternative code of the retrieved classification |
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 |
|---|---|---|
enabled | Boolean | Defines whether automatic spend authorisation is enabled or not for the rewards participant |
| minimum_wallet_balance | Float | The minimum wallet balance that should be available in order for an automatic awards spending to be applied. If specified then automatic awards spends will be created if the rewards participant has an available wallet amount which is equal or more than the minimum amount. Available from CRM.COM R13.0.0 |
| minimum_spend_amount | Float | The minimum amount that can be spend by that specific rewards participant during auto spend. If specified then automatic awards spends will be created if the rewards participant has an available amount that can be spend which is equal or more than the minimum amount. Available from CRM.COM R13.0.0 |
| maximum_spend_amount | Float | The maximum amount that can be spend by that specific rewards participant during auto spend. If specified then the amount of the automatic awards spends that will be created will be up to that specified amount, even if the available amount that can be spend is more than the maximum amount. Available from CRM.COM R13.0.0 |
| updated_date | Date | The last updated date on which the allow automatic spend setting was updated. |
| updated_by_user | Users Object | The User who last updated the allow automatic spend setting. |
| authorised_rewards_participating_merchants_set | Set of Rewards Participating Merchants | It defines the list of merchants which are authorised to perform automatic awards spending on that specific rewards participant, considering that those merchants are also allowing automatic awards spendings. If not specified then all rewards participating merchants are considered as authorised Available from CRM.COM R13.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participating merchant |
life_cycle_state | String | The life cycle state of the retrieved rewards participating merchant that can be EFFECTIVE or NOT_EFFECTIVE |
| description | String | A description of the retrieved rewards participating merchant |
| business_unit | Business Unit Object | The business unit that represents the rewards participating merchant Available from CRM.COM R18.0.0 |
| unit | Unit Object | The unit that represents the rewards participating merchant Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
| group | Group Object | The group that the rewards participating merchant's unit belongs to Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
| log_information | Log Information Object | The log information of the retrieved rewards participating merchant |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved group |
name | String | The name of the retrieved group |
community_name | String | The name of the community that the retrieved group belongs to |
alternative_code | String | The alternative code of the retrieved group |
| unified_code | String | The unified code of the retrieved group Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
|---|---|---|
enabled | Boolean | Defines whether the rewards participant is blocked from submitting spend requests |
| updated_date | Date | The date on which the rewards participant's blocking state was enabled/disabled |
| updated_by_user | Users Object | The user who enabled/disabled the rewards participant's blocking state |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant participating reward scheme |
| sign_up_on | Date | The date that the rewards participant signed up for that specific reward scheme |
| sign_off_on | Date | Available from CRM.COM R9.0.0 The date that the rewards participant signed off from that specific reward scheme |
| reference_code | Sting | The unique reference code that was used while signing up to that specific reward scheme. This is available only if it is required by the specific reward scheme Available from CRM.COM R12.7.0 |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant to that specific reward scheme Deprecated from CRM.COM R18.0.0 |
| sign_up_by_business_unit | Business Unit object | The business unit that signed up the rewards participant to that specific reward scheme Available from CRM.COM R18.0.0 |
| scheme | Reward Scheme Object | The reward scheme that the rewards participant has joint |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved reward scheme |
name | String | The name of the retrieved reward scheme |
alternative_code | String | The alternative code of the retrieved reward scheme |
| description | String | A description of the retrieved reward scheme |
| life_cycle_state | String | The life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE |
- No labels