POST customer_events/referrals/list
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
- p_demou (Deactivated)
This method returns information related with referral customer events. Multiple referral customer events are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
referred_rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the referred rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
| referred_accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the referred accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
From CRM.COM R17.0.0, access_token_identifier is supported | ||||||||||||||||||||||||||||||
referred_by_rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the referred by rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
| referred_by_accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the referred by accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
From CRM.COM R17.0.0, access_token_identifier is supported | ||||||||||||||||||||||||||||||
customer_event_classification_identifier (semi-optional) | Customer Event Classification Identifier | The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
| ||||||||||||||||||||||||||||||
submitted_after_date (optional) | Date | if specified then information related with referral customer events that was submitted after the specified date should be retrieved Available from CRM.COM R12.2.0 | ||||||||||||||||||||||||||||||
submitted_before_date (optional) | Date | if specified then information related with referral customer events that was submitted before the specified date should be retrieved Available from CRM.COM R12.2.0 | ||||||||||||||||||||||||||||||
created_after_date (semi-optional) | Date | If specified then information related with referral customer events that was created after the specified date should be retrieved Available from CRM.COM R15.1.0 | ||||||||||||||||||||||||||||||
created_before_date (optional) | Date | If specified then information related with referral customer events that was created before the specified date should be retrieved Available from CRM.COM R15.1.0 | ||||||||||||||||||||||||||||||
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 referral customer event |
| number | String | The number of the retrieved referral customer event |
| type | String | The type of the retrieved referral customer event which in this case is set to REFERRAL |
| life_cycle_state | String | The life cycle state of the customer event which can be POSTED or CANCELLED |
| performed_on | Date | The date that the customer event was actually performed |
| description | String | A description of the customer event |
| process_immediately | boolean | Defines if the customer event was processed immediately by various business processes or not Deprecated from CRM.COM R15.0.0 |
| external_system | String | Defines the third party system that generated the customer event Available from CRM.COM R10.0.0 |
| external_system_reference_number | String | Defines the reference number that uniquely identifies the customer event in the external system Available from CRM.COM R10.1.0 |
| total_awarded_amount | Number | The total amount that was awarded for the customer event in system currency Available from CRM.COM R13.1.0 |
| total_awarded_alternative_amount | Number | The total amount that was awarded for the customer event in the alternative currency. Available from CRM.COM R14.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 | Customer Event Classification Object | The classification of the customer event |
| accounts_receivable | Accounts Receivable Object | The related accounts receivable |
| performed_by_unit | Unit Object | The unit that initiated the customer event Deprecated from CRM.COM R18.0.0 |
| performed_by_business_unit | Business Unit Object | The business unit that initiated the customer event Available from CRM.COM R18.0.0 |
| performed_by_tap | Transaction Acquiring Point Object | The transaction acquiring point that initiated the customer event Available from CRM.COM R17.0.0 |
| authorized_by_access_token | Access Token Object | The access token that was used to identify and authorize the customer Available from CRM.COM R15.0.0 Deprecated from CRM.COM R18.0.0 |
Log Information Object | The log information related with the retrieved invoice | |
| referred_accounts_receivable | Accounts Receivable Object | The referred accounts receivable Available from CRM.COM R17.0.0 |
| referred_by_accounts_receivable | Accounts Receivable Object | The accounts receivable that provided the referral Available from CRM.COM R17.0.0 |
| referred_rewards_participant | Rewards Participant Object | The referred rewards participant Deprecated from CRM.COM R17.0.0 |
| referred_by_rewards_participant | Rewards Participant Object | The rewards participant that provided the referral Deprecated from CRM.COM R17.0.0 |
| award_reward_transactions_set | Set of Award Reward Transaction Object | The award reward transactions that were created as a result of the referral customer event |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"476A07F7C99133EA35D9AEA25475C8C1",
"referred_rewards_participant_identifier":{"access_token_identifier":{"authentication_code":"1234"}}
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"number": "7",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"referred_reward_participant":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "RewPar",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Marios",
"name": "Marios RewPar",
"id": "44829CCDBBD99A854554A6721B5784EE",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"passport_number": "111424555600",
"social_security_number": "1114245556",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "1114245556",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "405",
"name": "MariosM2",
"id": "6A303394941962F5DBF7516FD2F35994"
},
"number": "10",
"id": "B6838B7C46968C2A23F6C162959FA96F"
},
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriakos",
"name": "Kyriakos Xenofontos",
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "87878000",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "195",
"name": "Xenofontos",
"id": "5B51429862A7BCBAD60CC81982BBD45B"
},
"id": "B568245CF015508BCA63C979F592419D",
"referred_by_reward_participant":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": null,
"type": "PERSON",
"first_name": "Kyriakos",
"name": "Kyriakos Xenofontos",
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "87878000",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "195",
"name": "Xenofontos",
"id": "5B51429862A7BCBAD60CC81982BBD45B"
},
"number": "9",
"id": "26953ECA946B87D6925654784AB44930"
},
"classification":
{
"name": "Classification Test 1",
"id": "37DA1DB4A0E325A37D12CD0B8AA7CDF5",
"alternative_code": "ct1"
},
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"performed_by_unit":
{
"community_name": "Main Community",
"group_name": "Developers Group",
"name": "Developers Unit",
"id": "C4370788B2630BC8A99E8C7397406C09",
"description": null,
"alternative_code": null
},
"process_immediately": 0,
"log_information":
{
"updated_date": "2014-11-13T16:44:43",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-11-05T09:21:29",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"life_cycle_state": "POSTED",
"type": "REFERRAL",
"description": "Test for Award Event",
"performed_on": "2014-11-05T09:21:41"
}
]
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"referred_by_rewards_participant_identifier":{"number":"RP0000000061"},
"fields_set": "number,performed_on",
"submitted_after_date":"2016-06-22T15:00:00",
"submitted_before_date":"2016-11-03T15:00:12"
}
Response:
{
"data": [
{
"number": "13",
"performed_on": "2016-06-22T15:00:00"
},
{
"number": "12",
"performed_on": "2016-06-22T15:00:00"
},
{
"number": "10",
"performed_on": "2016-06-22T15:00:00"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}