POST customer_events/purchases/create
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
- Ekaterini Tzirtzipi
This method is used to create a purchase customer event in a posted life cycle state
Resource URL
Parameters
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:
From CRM.COM R15.0.0, access_token_identifier is supported For releases prior CRM.COM R17.0.0, this field was semi-optional | ||||||||||||||||||||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed fields are the following
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed identifier fields are the following
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
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_tap_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 | ||||||||||||||||||||||||||||||
process_immediately (optional) | Boolean | Defines if the customer event was processed immediately by various business processes or not Deprecated from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
reference_number (mandatory) | String | The reference number of the retrieved purchase customer event | ||||||||||||||||||||||||||||||
payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The identifier of the payment medium brand with which the purchase customer event has been made. 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 R10.0.0 | ||||||||||||||||||||||||||||||
payment_medium_type_identifier (optional) | Payment Medium Type Identifier | The payment medium type with which the purchase customer event has been made. 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 R10.0.0 | ||||||||||||||||||||||||||||||
payment_medium_identifier (optional) | String | The payment medium identifier with which the purchase customer event has been made Available from CRM.COM R10.0.0 | ||||||||||||||||||||||||||||||
external_system (optional) | String | Defines the third party system that generates the purchase customer event Available from CRM.COM R10.0.0 | ||||||||||||||||||||||||||||||
external_system_reference_number (optional) | String | Defines the reference number that uniquely identifies the purchase customer event in the external system 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 Deprecated from CRM.COM R18.0.0 | ||||||||||||||||||||||||||||||
invoice_identifier (optional) | Invoice Identifier | The CRM.COM invoice related with the purchase. The allowed invoice identifier fields are the following:
| ||||||||||||||||||||||||||||||
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 thrown. 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:
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
disable_instant_spend (optional) | Boolean | It determines if instant spend offers should be disabled (i.e. not applied) or not. By default all instant spend offers are applied if their conditions are met. Available from CRM.COM R14.4.0 | ||||||||||||||||||||||||||||||
terminal_identifier (optional) | String | An identifier of the terminal that submitted the purchase customer event Available from CRM.COM R15.1.0 | ||||||||||||||||||||||||||||||
total_discount_amount (optional) | Number | The total discount amount on the purchase customer event Available from CRM.COM R16.10.0 and CRM.COM R17.9.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_string_9 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
udf_string_16 (optional) | String | User Defined Field of type String Available from CRM.COM R10.1.0 | ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
(optional) | Spend Request Object | Information related with the spend request that should be created as part of the purchase customer event Available from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
(mandatory) | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product | ||||||||||||||||||||||||||||||
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 |
|---|---|---|
id | String | The ID of the retrieved purchase customer event |
| number | String | The number of the retrieved purchase customer event |
| type | String | The type of the retrieved purchase customer event which in this case is set to PURCHASE |
| 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 |
| reference_number | String | The reference number of the retrieved purchase customer event |
| payment_medium_identifier | String | The payment medium identifier with which the purchase customer event has been made Available from CRM.COM R10.0.0 |
| total_amount | Number | The total amount of the retrieved purchase customer event |
| net_amount | Number | The total net amount of the retrieved purchase customer event |
| vat_amount | Number | The total VAT amount of the retrieved purchase customer event |
| external_system | String | Defines the third party system that generated the retrieved purchase customer event Available from CRM.COM R10.0.0 |
| external_system_reference_number | String | Defines the unique reference of the external system that uniquely identifies the purchase customer event Available from CRM.COM R10.1.0 |
| requested_spend_amount | Number | The amount requested to be spent by the specified customer event in system currency Available from CRM.COM R17.0.0 |
| requested_spend_alternative_amount | Number | The amount requested to be spent by the specified customer event in alternative currency Available from CRM.COM R17.0.0 |
| total_awarded_amount | Number | The total amount that was awarded for that purchase customer event in system currency Available from CRM.COM R12.6.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 |
| total_spend_amount | Number | The total amount that was spent on that purchase customer event. The total spend amount = Total instant spend amount + Total automatic spend amount + Total additional spend amount Available from CRM.COM R12.6.0 |
| total_spend_alternative_amount | Number | The total alternative amount that was spent on that purchase customer event. The total spend alternative amount = Total instant spend alternative amount + Total automatic spend alternative amount + Total additional spend alternative amount Available from CRM.COM R17.0.0 |
| total_instant_spend_amount | Number | The total amount that was spent instantly on that purchase customer event Available from CRM.COM R12.6.0 |
| total_instant_spend_alternative_amount | Number | The total alternative amount that was spent instantly on that purchase customer event Available from CRM.COM R17.0.0 |
| total_automatic_spend_amount | Number | The total amount that was spent automatically on that purchase customer event, if the automatic awards spending is allowed Available from CRM.COM R12.6.0 |
| total_automatic_spend_alternative_amount | Number | The total alternative amount that was spent automatically on that purchase customer event, if the automatic awards spending is allowed Available from CRM.COM R17.0.0 |
| total_additional_spend_amount | Number | The total amount that was spent additionally on that purchase customer event Available from CRM.COM R12.6.0 |
| total_additional_spend_alternative_amount | Number | The total alternative amount that was spent additionally on that purchase customer event Available from CRM.COM R17.0.0 |
disable_instant_spend | Boolean | It determines if instant spend offers should be disabled (i.e. not applied) or not. By default all instant spend offers are applied if their conditions are met. Available from CRM.COM R14.4.0 |
terminal_identifier | String | An identifier of the terminal that submitted the purchase customer event Available from CRM.COM R15.1.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_string_9 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_10 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_11 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_12 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_13 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_14 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_15 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_16 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
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 to the retrieved invoice | |
| invoice | Invoice Object | The CRM.COM invoice related to the purchase |
| instant_spend_request | Spend Request Customer Event Object | The spend request customer event that was created instantly while processing and awarding the purchase customer event] Available from CRM.COM R10.0.0 Deprecated from CRM.COM R17.0.0 |
| automatic_spend_request | Spend Request Customer Event Object | The spend request customer event that was created automatically as part of the automatic awards spending process Available from CRM.COM R13.0.0 Deprecated from CRM.COM R17.0.0 |
| currency | Currency Object | The purchase customer event's related currency Available from CRM.COM R10.0.0 |
| payment_medium_brand | Payment Medium Brand Object | The payment medium brand with which the purchase customer event has been made Available from CRM.COM R10.0.0 |
| payment_medium_type | Payment Medium Brand Object | The payment medium type with which the purchase customer event has been made Available from CRM.COM R10.0.0 |
| products_set | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product |
| award_reward_transactions_set | Set of Award Reward Transaction Object | The award reward transactions that were created as a result of the purchase customer event |
| spend_reward_transactions_set | Set of Spend Reward Transaction Object | The spend reward transactions that were created as a result of the purchase customer event Available from CRM.COM R17.0.0 |
| spend_requests_set | Set of Spend Request Customer Event Objects | The spend request customer events that were submitted to the purchase customer event Available from CRM.COM R12.6.0 Deprecated from CRM.COM R17.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"162"},
"classification_identifier":{"name":"Purchase"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"description":"Testing creation of purchase event",
"process_immediately":1,
"reference_number":"RF000001",
"total_amount":235,
"net_amount":210,
"vat_amount":25,
"invoice_identifier":{"number":"I00000278"},
"payment_medium_brand_identifier":{"name":"VISA"},
"payment_medium_type_identifier":{"alternative_code":"CC"},
"payment_medium_identifier":"PI000001",
"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":"2016-03-24T15:49:59",
"udf_date_2":"2016-04-24T15:49:59",
"udf_date_3":"2016-05-24T15:49:59",
"udf_date_4":"2016-06-24T15:49:59",
"products_set":
[
{
"product_identifier":{"code":"Serendipity"},
"total_amount":60,
"net_amount":50,
"vat_amount":10
},
{
"product_identifier":{"code":"Bronze"},
"total_amount":180,
"net_amount":160,
"vat_amount":20
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"udf_float_1": 10,
"products_set": [
{
"total_amount": 180,
"net_amount": 160,
"id": "BAA0402F670744E5AD3C65C59052F318",
"quantity": 1,
"vat_amount": 20,
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "B18BD7B80DEF66E61ED3FBE4523F5383",
"name": "Termed - Flat",
"description": "Termed - Flat",
"alternative_code": "TS"
},
"id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
"description": "Bronze Premium Package",
"code": "Bronze",
"alternative_code": "BP"
}
},
{
"total_amount": 60,
"net_amount": 50,
"id": "BE28ECA140834D92B8E9038DE8A95FE8",
"quantity": 1,
"vat_amount": 10,
"product": {
"product_type": {
"service_type": "USAGE",
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "78F758444F6B8437F1A27F61D1BE84A5",
"name": "VOD",
"description": "Video on Demand Movies",
"alternative_code": "VOD"
},
"id": "02192DC60AF606C2124118AABCBFAAAA",
"description": "Serendipity",
"code": "Serendipity",
"alternative_code": "SRDP"
}
}
],
"udf_float_2": 20,
"udf_float_3": 30,
"udf_float_4": 40,
"number": "849",
"payment_medium_type": {
"id": "0EC912D6358341B4BAE55CFA70FE0F2D",
"name": "Credit Card",
"description": "Payment Medium Type 1: Credit Card",
"alternative_code": "CC"
},
"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"
},
"payment_medium_brand": {
"id": "F7B18DE5D55E452C81AF6F1EAD3E934C",
"name": "VISA",
"description": "Payment Medium Brand 1: Visa",
"alternative_code": "V"
},
"id": "01B0FD5A49814677BBF15662482C39FE",
"award_reward_transactions_set": [],
"classification": {
"id": "2164EF87DBAB4225ACC81CE90712933A",
"name": "Purchase",
"alternative_code": "P"
},
"udf_date_1": "2016-03-24T15:49:59",
"udf_date_2": "2016-04-24T15:49:59",
"udf_date_3": "2016-05-24T15:49:59",
"udf_date_4": "2016-06-24T15:49:59",
"invoice": {
"issued_on": "2014-10-24T16:15:15",
"total_amount": 133,
"life_cycle_state": "POSTED",
"unsettled_amount": 0,
"number": "I00000278",
"due_on": "2014-11-03T16:15:15",
"id": "470154904D2B2E0107F58A0330609D63",
"reference_number": "325",
"outstanding_amount": 0,
"posted_on": "2014-10-24T16:15:15"
},
"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"
},
"vat_amount": 30,
"process_immediately": 1,
"log_information": {
"updated_date": "2016-06-22T15:37:00",
"created_date": "2016-06-22T15:37:00",
"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": 240,
"life_cycle_state": "POSTED",
"net_amount": 210,
"payment_medium_identifier": "PI000001",
"type": "PURCHASE",
"description": "Testing creation of purchase event",
"reference_number": "RF000001",
"performed_on": "2016-06-22T15:00:00"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000019"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2017-07-12T15:00:00",
"description":"Applying Interactive Reward Offers, considering the Spend Method",
"process_immediately":1,
"reference_number":"RF000001",
"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",
"products_set":
[
{
"product_identifier":{"code":"PK_SmartCard"},
"total_amount":11,
"net_amount":11,
"vat_amount":0
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"udf_float_1": 10,
"products_set": [
{
"total_amount": 11,
"net_amount": 11,
"id": "8230752E72814A48A886806228FBB61D",
"quantity": 1,
"vat_amount": 0,
"product": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "7FC0F87C40C74ABCA19F1CA870E51687",
"name": "PK_Product Type_SB3",
"description": null,
"alternative_code": "PT_2"
},
"id": "2ED97CB3DC0141C5B8316525B9D54AB7",
"description": "PK_SmartCard",
"code": "PK_SmartCard",
"alternative_code": "P_8"
}
}
],
"udf_float_2": 20,
"udf_float_3": 30,
"udf_float_4": 40,
"number": "336",
"payment_medium_type": null,
"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",
"instant_spend_request": {
"classification": null,
"number": "72",
"performed_by_unit": {
"id": "1",
"name": "Admin Unit",
"description": "admin unit",
"alternative_code": "adminunit"
},
"process_immediately": 1,
"spend_reward_transaction": {
"total_amount": 5,
"life_cycle_state": "POSTED",
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kestora",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Polina",
"type": "PERSON",
"id": "F038161F36C845B98CEE7361A8C92157",
"name": "Polina Kestora",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": null,
"two_character_code": null,
"id": "231",
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"alternative_code": "IRN"
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": 3,
"day": 4,
"year": 1988
},
"id_number": "112233",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR0000000164",
"id": "C6CBAC948E53498F83FF52E6CD8B7221",
"name": "ACR0000000164 Polina Kestora"
},
"number": "RP0000000019",
"id": "EA95AA28BE1F4C8B9C983487278210D3"
},
"number": "57",
"net_amount": 5,
"id": "A3CB8C42085B43BB9F98C50D4580E961",
"vat_amount": 0
},
"log_information": {
"updated_date": "2016-07-14T09:38:54",
"created_date": "2016-07-14T09:38:54",
"created_by_unit": {
"id": "1",
"name": "Admin Unit",
"description": "admin unit",
"alternative_code": "adminunit"
},
"updated_by_unit": {
"id": "1",
"name": "Admin Unit",
"description": "admin unit",
"alternative_code": "adminunit"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "POSTED",
"accounts_receivable": {
"account_owner": {
"last_name": "Kestora",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Polina",
"type": "PERSON",
"id": "F038161F36C845B98CEE7361A8C92157",
"name": null,
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": 3,
"day": 4,
"year": 1988
},
"id_number": "112233",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR0000000164",
"id": "C6CBAC948E53498F83FF52E6CD8B7221",
"name": "ACR0000000164 Polina Kestora"
},
"spend_amount": 5,
"type": "SPEND_REQUEST",
"id": "B49F7C337870455C9931C067DF6B3E80",
"description": null,
"performed_on": "2016-07-14T09:38:54"
},
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable": {
"account_owner": {
"last_name": "Kestora",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Polina",
"type": "PERSON",
"id": "F038161F36C845B98CEE7361A8C92157",
"name": "Polina Kestora",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": null,
"two_character_code": null,
"id": "231",
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"alternative_code": "IRN"
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": 3,
"day": 4,
"year": 1988
},
"id_number": "112233",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR0000000164",
"id": "C6CBAC948E53498F83FF52E6CD8B7221",
"name": "ACR0000000164 Polina Kestora"
},
"payment_medium_brand": null,
"id": "AC062E7AD94A401B8D8153F1CD28FB58",
"award_reward_transactions_set": [
{
"life_cycle_state": "POSTED",
"amount": 5,
"rewards_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Kestora",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Polina",
"type": "PERSON",
"id": "F038161F36C845B98CEE7361A8C92157",
"name": null,
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": 3,
"day": 4,
"year": 1988
},
"id_number": "112233",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR0000000164",
"id": "C6CBAC948E53498F83FF52E6CD8B7221",
"name": "ACR0000000164 Polina Kestora"
},
"number": "RP0000000019",
"id": "EA95AA28BE1F4C8B9C983487278210D3"
},
"number": "1178",
"id": "9C0A9B29A07B42CDBFA0279B6D4FAB37"
}
],
"classification": null,
"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",
"invoice": null,
"performed_by_unit": {
"community_name": "Community",
"id": "1",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "admin unit",
"alternative_code": "adminunit"
},
"vat_amount": 0,
"process_immediately": 1,
"log_information": {
"updated_date": "2016-07-14T09:38:54",
"created_date": "2016-07-14T09:38:54",
"created_by_unit": {
"community_name": "Community",
"id": "1",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "admin unit",
"alternative_code": "adminunit"
},
"updated_by_unit": {
"community_name": "Community",
"id": "1",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "admin unit",
"alternative_code": "adminunit"
},
"created_by_user": {
"person_name": "CRM COM",
"username": "MPAdministrator",
"id": "1",
"email": "dev@crm.com"
},
"updated_by_user": {
"person_name": "CRM COM",
"username": "MPAdministrator",
"id": "1",
"email": "dev@crm.com"
}
},
"total_amount": 11,
"life_cycle_state": "POSTED",
"net_amount": 11,
"payment_medium_identifier": null,
"type": "PURCHASE",
"description": "Applying Interactive Reward Offers, considering the Spend Method",
"reference_number": "RF000001",
"performed_on": "2017-07-12T15:00:00"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"162"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2014-05-05T15:49:59",
"description":"first purchase event",
"process_immediately":0,
"reference_number":"RF001",
"total_amount":235,
"net_amount":210,
"vat_amount":25,
"invoice_identifier":{"number":"I00000882"},
"products_set":
[
{
"product_identifier":{"code":"Decoders 1"},
"total_amount":60,
"net_amount":50,
"vat_amount":10,
"quantity":2
},
{
"product_identifier":{"code":"Smartcard 1"},
"total_amount":180,
"net_amount":160,
"vat_amount":20
}
],
"fields_set":"number,id,performed_by_unit,classification,invoice,products_set,accounts_receivable"
}
Response:
{
"data": {
"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": "2016-07-05T13:33:24",
"updated_date": "2016-07-05T13:33:25",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"description": "first purchase event",
"currency_rate_period": null,
"udf_date_2": null,
"type": "PURCHASE",
"udf_date_1": null,
"udf_date_4": null,
"products_set": [
{
"product": {
"code": "Smartcard",
"product_type": {
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "S",
"composition_method": "FLAT",
"name": "SMARTCARD",
"description": "SMARTCARD",
"id": "D6BE0209EC0149989A89972CE889DF8B",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "S",
"description": null,
"id": "4F656ED5DAC44168B0805227881202CD"
},
"quantity": 2,
"vat_amount": 10,
"total_amount": 60,
"id": "8D0E61A56B8B4987B04ED9446681EF26",
"net_amount": 50
}
],
"udf_date_3": null,
"number": "106",
"udf_float_3": null,
"udf_float_4": null,
"vat_amount": 10,
"award_reward_transactions_set": null,
"id": "3FD06F2BCE834444A3FD65A7ED6DEB85",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000050",
"name": "ACR0000000050 Ekaterini Tzirtzipi",
"id": "1B61E3A9DB864363A1502829952DF3CD",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Ekaterini Tzirtzipi",
"last_name": "Tzirtzipi",
"id": "3236797A43C746F8AD9F4A91A4035735",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Ekaterini",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "343434",
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": 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",
"performed_on": "2016-05-05T15:49:59",
"classification": null,
"reference_number": "RF001",
"process_immediately": 0,
"total_amount": 60,
"net_amount": 50,
"invoice": {
"posted_on": "2016-06-23T09:55:50",
"number": "I00000599",
"total_amount": 38.15,
"unsettled_amount": 0,
"issued_on": "2016-06-23T09:55:50",
"id": "13A2AE71163C4ED3994F14396F6173D9",
"life_cycle_state": "POSTED",
"outstanding_amount": 0,
"reference_number": "75",
"due_on": "2016-06-25T09:55:50"
},
"udf_string_6": null,
"udf_string_7": null,
"performed_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
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",
"description":"purchase event",
"process_immediately":true,
"reference_number":"PCE1API32",
"disable_instant_spend":true,
"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
}
]
}
Response:
{
"data": {
"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:15:28",
"updated_date": "2018-09-07T13:15:32",
"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_requests_set": [],
"payment_medium_brand": null,
"type": "PURCHASE",
"products_set": [
{
"product": {
"code": "Serendipity",
"product_type": {
"meter_reading_type": null,
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"unit_of_measurement": null,
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540",
"priority_level": null
},
"quantity": 1,
"vat_amount": 0,
"total_amount": 3,
"id": "8D907F5DF2DE4AC2A4D9AD23A61F1CB2",
"net_amount": 3
}
],
"number": "1607",
"total_automatic_spend_amount": 0,
"id": "656539A4B48E409699179497FC9C04B8",
"total_awarded_amount": 0.75,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"total_instant_spend_amount": 0,
"life_cycle_state": "POSTED",
"classification": null,
"reference_number": "PCE1API32",
"total_amount": 3,
"automatic_spend_request": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null,
"external_system_reference_number": null,
"description": "purchase event",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"vat_amount": 0,
"award_reward_transactions_set": [
{
"number": "3730",
"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": "553D5ED7FD5D4EE9923DB96D012ADC47",
"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": {
"id_number": "451232",
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"industry": null,
"name_day": {
"month": 5,
"day": 21
},
"passport_number_expiration_date": null,
"id_number_expiration_date": null,
"passport_number": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "57A9AC82559149019061B743F13CD39B",
"life_cycle_state": "EFFECTIVE"
}
}
],
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"currency": {
"suffix_symbol": "N/A",
"prefix_symbol": "€",
"decimal_part_name": "cents",
"code": "EUR",
"integer_part_name": "euro",
"id": "2",
"life_cycle_state": "EFFECTIVE"
},
"udf_string_10": null,
"udf_float_1": null,
"udf_float_2": null,
"total_additional_spend_amount": 0,
"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": {
"id_number": "451232",
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"industry": null,
"name_day": {
"month": 5,
"day": 21
},
"passport_number_expiration_date": null,
"id_number_expiration_date": null,
"passport_number": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"performed_on": "2018-09-07T13:09:00",
"process_immediately": true,
"payment_medium_type": null,
"payment_medium_identifier": null,
"instant_spend_request": null,
"disable_instant_spend": true,
"net_amount": 3,
"invoice": null,
"performed_by_unit": {
"alternative_code": "MRAU",
"group_name": "Merchant ABCD",
"community_name": "CommunityB",
"name": "Merchant A unit",
"description": null,
"id": "AB18F69E3CA84413BABEF07713D410CB"
},
"total_spend_amount": 0,
"external_system": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}