Available from CRM.COM R10.0.0
This method is used to create multiple purchase customer events within a single Web API method call. Note that the maximum number of purchase customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
(mandatory) | Set of Purchases Customer Event Objects | The set of purchases customer events that will be created by this Web API method. Note that the maximum number of purchases customer events that can be specified within a single Web API call is 1000 | |||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the customer events. 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:
| |||||||||
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 |
Referred Parameter Objects
Response Data
Name | Type | Description |
|---|---|---|
Set of Processed customer Events Objects | A set that contains the ID and the number of the customer events that were created
| |
| unprocessed_customer_events_set | Set of Unprocessed customer Events Objects | A set that contains the customer events that were not created due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description.
|
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"purchase_customer_events_set":
[
{
"request_unique_identifier":"31",
"accounts_receivable_identifier":{"number":"ACR0000000228"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"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
}
]
}
,
{
"request_unique_identifier":"32",
"accounts_receivable_identifier":{"number":"ACR0000000228"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"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
}
]
},
{
"request_unique_identifier":"33",
"accounts_receivable_identifier":{"number":"ACR00008"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"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
}
]
},
{
"request_unique_identifier":"34",
"accounts_receivable_identifier":{"number":"ACR0000058"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"reference_number":"RF01",
"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:
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR00008) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "33"
},
{
"error_description": "Error:Account (ACR0000058) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "34"
}
],
"processed_customer_events_set": [
{
"number": "123",
"id": "C6F33A7C8A38446FA1A58ACDF105AFE8",
"request_unique_identifier": "31"
},
{
"number": "124",
"id": "DFB1ED07A8DB45F6A9205E3CCFCDC14E",
"request_unique_identifier": "32"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}