This method is used to create an achievement customer event in a posted life cycle state
Resource URL
Parameterse
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
accounts_receivable_identifier (mandatory) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following:
For releases prior CRM.COM R17.0.0, this field was semi-optional From CRM.COM R17.0.0, the access token attributes are supported | ||||||||||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
classification_identifier (mandatory) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||||||||||||||||||||||||||
product_identifier (optional) | Product Identifier | The product of the customer event. Any type of products can be specified. The allowed product identifier fields are the following:
Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
payment_medium_type_identifier (optional) | Payment Medium Type Identifier | The payment medium type of the customer event. Only payment medium types which are allowed in the related accounts receivable can be specified. If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium type as specified in the related access token classification The allowed payment medium type identifier fields are the following:
Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The payment medium brand of the customer event. Only payment medium brands which are allowed in the related accounts receivable can be specified. If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium brand as specified in the related access token classification The allowed payment medium brand identifier fields are the following:
Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
payment_medium_identifier (optional) | String | The payment medium identifier of the customer event. Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
amount (optional) | Number | The achievement customer event's amount Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
performed_by_business_unit_identifier (semi-optional) | Business Unit Identifier | The business unit that initiated the customer event. The allowed identifier fields are the following
Available from CRM.COM R18.0.0 From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_device_identifier is specified | ||||||||||||||||||||||||||||||
performed_by_unit_identifier (semi-optional) | Unit Identifier | The unit that initiated the customer event. The allowed identifier fields are the following
For releases prior CRM.COM R17.0.0, this attribute was mandatory From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_device_identifier is specified Deprecated from CRM.COM R18.0.0 | ||||||||||||||||||||||||||||||
performed_by_tap_identifier (semi-optional) | Transaction Acquiring Point Identifier | The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following
Available from CRM.COM R17.0.0 From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_unit_identifier is specified From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_business_unit_identifier is specified | ||||||||||||||||||||||||||||||
performed_on (mandatory) | Date | The date that the customer event was actually performed | ||||||||||||||||||||||||||||||
description (optional) | String | A description of the customer event | ||||||||||||||||||||||||||||||
external_system (optional) | String | The third party system that generates the customer event Available from CRM.COM R10.0.0 | ||||||||||||||||||||||||||||||
external_system_reference_number (optional) | String | The external system's unique reference number of customer event Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
authorized_by_access_token_identifier (optional) | Access Token Identifier | The access token that was used to identify and authorized the customer. This information will be overridden if the customer was identified via an access token through this Web API call. The allowed access token identifier fields are the following:
Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
promo_code (optional) | String | The effective, not expired promo code that can be used on the customer event. The promo code is validated against its related promotion campaign's settings in order to be provided. Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
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 |
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 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":"{{token}}",
"accounts_receivable_identifier":{"number":"162"},
"classification_identifier":{"name":"Achievement"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-28T15:49:59",
"description":"Testing creation of Achievement Customer Event",
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"udf_float_4": 40,
"number": "42",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable": {
"account_owner": {
"last_name": "Mercer",
"middle_name": "111111111",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Ben11 omonoia",
"type": "PERSON",
"id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
"name": "Mercer Ben11 omonoia",
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": {
"three_character_code": "AND",
"two_character_code": "AD",
"id": "132",
"name": "ANDORRA",
"alternative_code": null
},
"social_security_number": null,
"passport_number": null,
"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": 6,
"day": 14
},
"date_of_birth": {
"month": 11,
"day": 9,
"year": 1963
},
"id_number": "1212125",
"industry": {
"id": "31BC2070C79EAE5455BFAD41599C5190",
"name": "Marketing1",
"code": "MK"
},
"id_issued_by_country": {
"three_character_code": "DZA",
"two_character_code": "DZ",
"id": "130",
"name": "ALGERIA",
"alternative_code": null
}
}
},
"life_cycle_state": "ACTIVE",
"number": "162",
"id": "3C66BD54CCDB6BC1096C23F6D8899752",
"name": "Ben Mercer 1"
},
"id": "C32E7BAAAF0E4E21A5884D6DB80BD3AE",
"award_reward_transactions_set": null,
"classification": {
"id": "5116DBDCD681442F818FA6D48EC31EE2",
"name": "Achievement",
"alternative_code": "A"
},
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"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": 0,
"log_information": {
"updated_date": "2016-06-28T18:15:06",
"created_date": "2016-06-28T18:15:06",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "POSTED",
"type": "ACHIEVEMENT",
"description": "Testing creation of Achievement Customer Event",
"performed_on": "2016-06-28T15:49:59"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR000330"},
"classification_identifier":{"name":"5 Stars Sales Person Achievement"},
"performed_by_unit_identifier":{"name":"Sales Department 1"},
"performed_on":"2014-05-05T15:49:59",
"description":"RW TC 14",
"process_immediately":0,
"fields_set":"accounts_receivable,number,id,description,performed_by_unit,classification"
}
Response:
{
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": 11,
"day": 28,
"year": 1950
},
"id_number": "142536",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000330",
"id": "FB39F10F00B7D0ED2B686051B41779B6",
"name": "May Jones Reward"
},
"classification": {
"id": "0647739C25A085184703A6F0047808B6",
"name": "5 Stars Sales Person Achievement",
"alternative_code": "5SSPA"
},
"number": "40",
"id": "DF9D9880717A4A5BAE52DFC60E1E8C63",
"description": "RW TC 14",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "A01DEAA885B5B0F14769F983A2F6A16E",
"name": "Sales Department 1",
"group_name": "Sales Manager Group",
"description": null,
"alternative_code": "SD1"
}
}
}