POST customer_events/achievements/cancel
- Former user (Deleted)
- p_demou (Deactivated)
Available from CRM.COM R9.0.0
This method is used in order to cancel a posted achievement customer event. This method can be applied only on posted achievement customer events. A single achievement customer event can be cancelled by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
customer_event_identifier (mandatory) | Customer Event identifier | The identifier of the customer event that should be cancelled. Only customer events of type achievement which are posted can be specified. The allowed customer event 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 Available from CRM.COM R10.0.0 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved achievement customer event |
| number | String | The number of the retrieved achievement customer event |
| type | String | The type of the retrieved achievement customer event which in this case is set to ACHIEVEMENT |
| 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 |
| payment_medium_identifier | String | The payment medium identifier related with the achievement customer event Available from CRM.COM R15.0.0 |
| amount | Number | The amount related with the achievement customer event Available 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 external system's unique identifier of the customer event 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 R12.2.0 and CRM.COM R13.1.0 onward |
| 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 |
| product | Product Object | The product of the customer event. Available from CRM.COM R15.0.0 |
| payment_medium_type | Payment Medium Type Object | The payment medium type of the customer event Available from CRM.COM R15.0.0 |
| payment_medium_brand | Payment Medium Brand Object | The payment medium brand of the customer event Available from CRM.COM R15.0.0 |
| 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 | |
| award_reward_transactions_set | Set of Award Reward Transaction Object | The award reward transactions that were created as a result of the achievement customer event |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"8868DA44EBC44E81A841911932DCF561",
"customer_event_identifier":{"number":"13"}
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"number": "13",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Rewards",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Jessica",
"type": "PERSON",
"id": "79B02448A3F3A9890FCFA899A94D6D72",
"name": "Rewards Jessica",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "867583",
"passport_number": "867583",
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": "867582",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000331",
"id": "1F695BE767C2EC001433CA9E1C0F47BA",
"name": "Jessica Rewards"
},
"id": "DBFA98E599961C74E02C0B6F1E4FC0DF",
"award_reward_transactions_set": null,
"classification":
{
"id": "602130E6B9F01FA657C5EC0891E93CD0",
"name": "3rd Party System Initiated",
"alternative_code": "3PSI"
},
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"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,
"log_information":
{
"updated_date": "2016-02-24T17:59:02",
"created_date": "2015-01-22T10:55:53",
"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"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "CANCELLED",
"type": "ACHIEVEMENT",
"description": "API TEST achievement event",
"performed_on": "2015-01-15T15:49:59"
}
}