Available from CRM.COM R9.0.0
This method is used to create a purchase customer event in a posted life cycle state, and a spend request customer event related with that purchase customer event. In case of an error none of the customer events is created
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
accounts_receivable_identifier (semi-optional) | Accounts receivable Identifier | The accounts receivable that will be related with both the purchase customer event and the spend request customer event that will be created. The allowed accounts receivable identifier fields are the following:
From CRM.COM R15.0.0, access_token_identifier is supported | ||||||||||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The rewards participant that will be related with both the purchase customer event and the spend request customer event that will be created. The allowed rewards participant identifier fields are the following:
| ||||||||||||||||||||||||||||||
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated both the purchase customer event and the spend request customer event that will be created. The allowed unit identifier fields are the following:
| ||||||||||||||||||||||||||||||
performed_on (mandatory) | Date | The date that both the purchase customer event and the spend request customer event that will be created were actually performed | ||||||||||||||||||||||||||||||
process_immediately (optional) | boolean | Defines if the customer events should be processed immediately by various business processes or not Deprecated from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
external_system (optional) | String | Defines the third party system that generates the customer event Available from CRM.COM R10.0.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 | ||||||||||||||||||||||||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the customer event. If specified then it is validated against the currency of the related performed by unit (i.e. the default currency) and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| ||||||||||||||||||||||||||||||
(mandatory) | Purchase Customer Event Object | Information related with the purchase customer event to be created | ||||||||||||||||||||||||||||||
(mandatory) | Spend Request Customer Event Object | Information related with the spend request that should be created. The spend request will automatically be related with the specified purchase customer event. | ||||||||||||||||||||||||||||||
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 |
Referred Parameter Objects
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 |
|---|---|---|
| purchase_customer_event | Purchase Customer Event Object | The purchase customer event that was created |
| spend_request_customer_event | Spend Request Customer Event Object | The spend request customer event that was created |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR001101"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"process_immediately":1,
"purchase_customer_event":
{
"reference_number":"RF00002",
"payment_medium_brand_identifier":{"id":"A01DB55EE5624E80ADA3CD7AF166AF30"},
"payment_medium_type_identifier":{"alternative_code":"CC"},
"payment_medium_identifier":"PI000003",
"total_amount":88,
"net_amount":80,
"vat_amount":8,
"products_set":
[
{
"product_identifier":{"code":"Serendipity"},
"total_amount":88,
"net_amount":80,
"vat_amount":8
}
]
},
"spend_request_customer_event":
{
"product_identifier":{"name":"Spend Request Classification"}
}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"purchase_customer_event": {
"award_reward_transactions_set": [],
"classification": null,
"number": "862",
"payment_medium_type": {
"id": "0EC912D6358341B4BAE55CFA70FE0F2D",
"name": "Credit Card",
"description": "Payment Medium Type 1: Credit Card",
"alternative_code": "CC"
},
"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,
"vat_amount": 8,
"log_information": {
"updated_date": "2016-06-22T16:18:25",
"created_date": "2016-06-22T16:18:25",
"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",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"total_amount": 88,
"accounts_receivable": {
"account_owner": {
"last_name": "Ioannou212",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Marios",
"type": "PERSON",
"id": "028657D9E5E74F4EAAB25C9DD0EBB69C",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001101",
"id": "0F0638457F2D4133BC6FAD1A4DBACF26",
"name": "ACR001101"
},
"life_cycle_state": "POSTED",
"payment_medium_brand": {
"id": "A01DB55EE5624E80ADA3CD7AF166AF30",
"name": "AMERICAN EXPRESS",
"description": "Payment Medium Brand 2: American Express",
"alternative_code": "AE"
},
"net_amount": 80,
"payment_medium_identifier": "PI000003",
"type": "PURCHASE",
"id": "E295AE4AFA15410DBAF8B17E502785AD",
"description": null,
"reference_number": "RF00002",
"performed_on": "2016-06-22T15:00:00"
},
"spend_request_customer_event": {
"classification": null,
"number": "105",
"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,
"spend_reward_transaction": null,
"log_information": {
"updated_date": "2016-06-22T16:18:25",
"created_date": "2016-06-22T16:18:25",
"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",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"life_cycle_state": "POSTED",
"accounts_receivable": {
"account_owner": {
"last_name": "Ioannou212",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Marios",
"type": "PERSON",
"id": "028657D9E5E74F4EAAB25C9DD0EBB69C",
"name": null,
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001101",
"id": "0F0638457F2D4133BC6FAD1A4DBACF26",
"name": "ACR001101"
},
"spend_amount": null,
"type": "SPEND_REQUEST",
"id": "27277BB77DCC44F28307419D57BAB750",
"description": null,
"performed_on": "2016-06-22T15:00:00"
}
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"name":"0000000001 Eleni M"},
"performed_by_unit_identifier":{"name":"Merchant A unit"},
"performed_on":"2018-09-07T13:09:00",
"process_immediately":1,
"purchase_customer_event":
{
"disable_instant_spend":true,
"reference_number":"RF00002",
"total_amount":3,
"net_amount":3,
"vat_amount":0,
"products_set":
[
{
"product_identifier":{"code":"Serendipity"},
"total_amount":3,
"net_amount":3,
"vat_amount":0,
"quantity":1
}
]
},
"spend_request_customer_event":
{
"product_identifier":{"name":"Spend Request Classification"}
}
}
Response:
{
"data": {
"purchase_customer_event": {
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2018-09-07T13:35:17",
"updated_date": "2018-09-07T13:35:27",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "test@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "test@crm.com",
"username": "MPAdministrator"
}
},
"payment_medium_brand": null,
"description": null,
"accounts_receivable": {
"number": "0000000001",
"name": "0000000001 Eleni M",
"id": "8DDDA5F17D9641FC97A32FEAEE1F8AC6",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Eleni Mich",
"last_name": "Mich",
"id": "EE15F92F5AD9487692DA4DD34D35CA09",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Eleni",
"demographics": {
"name_day": {
"month": 5,
"day": 21
},
"id_number": "451232",
"passport_number_expiration_date": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"id_number_expiration_date": 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": "PURCHASE",
"classification": null,
"performed_on": "2018-09-07T13:09:00",
"reference_number": "RF00002",
"process_immediately": true,
"number": "1611",
"payment_medium_type": null,
"payment_medium_identifier": null,
"vat_amount": 0,
"award_reward_transactions_set": [
{
"number": "3734",
"amount": 0.75,
"currency_rate_period": {
"from_date": "2018-08-07 00:00:00.0",
"to_date": null,
"rate": 5,
"inverse_rate": 0.2,
"currency": null,
"id": "71996F27996C44DC9E2FD4C2F05AE563"
},
"id": "907CCE43511844C19E871600EEB89673",
"life_cycle_state": "POSTED",
"contribution_percentage": null,
"rewards_participant": {
"number": "1",
"accounts_receivable": {
"number": "0000000001",
"name": "0000000001 Eleni M",
"id": "8DDDA5F17D9641FC97A32FEAEE1F8AC6",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Eleni Mich",
"last_name": "Mich",
"id": "EE15F92F5AD9487692DA4DD34D35CA09",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Eleni",
"demographics": {
"name_day": {
"month": 5,
"day": 21
},
"id_number": "451232",
"passport_number_expiration_date": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"id_number_expiration_date": null,
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "57A9AC82559149019061B743F13CD39B",
"life_cycle_state": "EFFECTIVE"
}
}
],
"total_amount": 3,
"instant_spend_request": null,
"automatic_spend_request": null,
"currency": {
"suffix_symbol": "N/A",
"prefix_symbol": "€",
"decimal_part_name": "cents",
"code": "EUR",
"integer_part_name": "euro",
"id": "2",
"life_cycle_state": "EFFECTIVE"
},
"id": "687479C3899C4EFF8A6A7450C86725EE",
"net_amount": 3,
"performed_by_unit": {
"alternative_code": "MRAU",
"group_name": "Merchant ABCD",
"community_name": "CommunityB",
"name": "Merchant A unit",
"description": null,
"id": "AB18F69E3CA84413BABEF07713D410CB"
}
},
"spend_request_customer_event": {
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2018-09-07T13:35:27",
"updated_date": "2018-09-07T13:35:27",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "test@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "test@crm.com",
"username": "MPAdministrator"
}
},
"spend_amount": 3,
"description": null,
"accounts_receivable": {
"number": "0000000001",
"name": "0000000001 Eleni M",
"id": "8DDDA5F17D9641FC97A32FEAEE1F8AC6",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Eleni Mich",
"last_name": "Mich",
"id": "EE15F92F5AD9487692DA4DD34D35CA09",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Eleni",
"demographics": {
"name_day": {
"month": 5,
"day": 21
},
"id_number": "451232",
"passport_number_expiration_date": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"id_number_expiration_date": 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": "2018-09-07T13:09:00",
"automatic_spend": false,
"reduction_method": "FRONT_END_REDUCTION",
"classification": null,
"process_immediately": true,
"spend_reward_transaction": {
"number": "470",
"vat_amount": 0,
"total_amount": 15,
"currency_rate_period": {
"from_date": "2018-08-07 00:00:00.0",
"to_date": null,
"rate": 5,
"inverse_rate": 0.2,
"currency": null,
"id": "71996F27996C44DC9E2FD4C2F05AE563"
},
"id": "5866580210454ABAB5A8EF971C1872A7",
"net_amount": 15,
"life_cycle_state": "POSTED",
"rewards_participant": {
"number": "1",
"accounts_receivable": {
"number": "0000000001",
"name": "0000000001 Eleni M",
"id": "8DDDA5F17D9641FC97A32FEAEE1F8AC6",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Eleni Mich",
"last_name": "Mich",
"id": "EE15F92F5AD9487692DA4DD34D35CA09",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Eleni",
"demographics": {
"name_day": {
"month": 5,
"day": 21
},
"id_number": "451232",
"passport_number_expiration_date": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"id_number_expiration_date": null,
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "57A9AC82559149019061B743F13CD39B",
"life_cycle_state": "EFFECTIVE"
}
},
"number": "550",
"currency": {
"suffix_symbol": "N/A",
"prefix_symbol": "€",
"decimal_part_name": "cents",
"code": "EUR",
"integer_part_name": "euro",
"id": "2",
"life_cycle_state": "EFFECTIVE"
},
"id": "0E36B9248D7A4C59B2215CFD3F27FE78",
"instant_spend": false,
"performed_by_unit": {
"alternative_code": "MRAU",
"group_name": "Merchant ABCD",
"community_name": "CommunityB",
"name": "Merchant A unit",
"description": null,
"id": "AB18F69E3CA84413BABEF07713D410CB"
}
}
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}