| Tip |
|---|
Available from CRM.COM R10.0.0 |
Table of Contents maxLevel 2
POST customer_events/bulk/achievements/create
This method is used to create multiple achievement customer events within a single Web API method call. Note that the maximum number of achievement customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
achievement_customer_events_set (mandatory) | Set of Achievement Customer Event Objects | The set of achievement customer events that will be created by this Web API method. Note that the maximum number of achievement customer events that can be specified within a single Web API call is 1000 |
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 |
...
| title | bulk achievement customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(mandatory)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
external_system
(optional)
...
external_system_reference_number
(optional)
...
The unique reference number of the customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_1
(optional)
...
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
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"achievement_customer_events_set":
[
{
"request_unique_identifier":"221",
"accounts_receivable_identifier":{"number":"ACR0000000077"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
}
,
{
"request_unique_identifier":"222",
"accounts_receivable_identifier":{"number":"ACR0000000077"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
},
{
"request_unique_identifier":"223",
"accounts_receivable_identifier":{"number":"ACR000177"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
},
{
"request_unique_identifier":"224",
"accounts_receivable_identifier":{"number":"ACR0097"},
"classification_identifier":{"name":"Customer Feedback 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00"
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR000177) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "223"
},
{
"error_description": "Error:Account (ACR0097) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "224"
}
],
"processed_customer_events_set": [
{
"number": "45",
"id": "A4340AC3F973495E81F69A75D2D32BD3",
"request_unique_identifier": "221"
},
{
"number": "46",
"id": "AF2546A34840400AA2F0437470CBA5AB",
"request_unique_identifier": "222"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/bulk/purchases/create
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)
...
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:
...
| Tip |
|---|
...
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
...
| title | bulk purchase customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(optional)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
reference_number
(mandatory)
...
payment_medium_brand_identifier
(optional)
...
The identifier of the payment medium brand with which the purchase customer event has been made. The allowed payment medium brand identifier fields are the following:
...
payment_medium_type_identifier
(optional)
...
The payment medium type with which the purchase customer event has been made. The allowed payment medium type identifier fields are the following:
...
payment_medium_identifier
(optional)
...
The payment medium identifier with which the purchase customer event has been made
...
invoice_identifier
(optional)
...
external_system
(optional)
...
external_system_reference_number
(optional)
...
The unique reference number of the customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_1
(optional)
...
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)
...
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_10
(optional)
...
String
...
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_11
(optional)
...
String
...
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_12
(optional)
...
String
...
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_13
(optional)
...
String
...
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_14
(optional)
...
String
...
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_15
(optional)
...
String
...
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_16
(optional)
...
String
...
User Defined Field of type String
| Tip |
|---|
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
...
(mandatory)
...
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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": ""
}
} |
POST customer_events/bulk/referrals/create
This method is used to create multiple referral customer events within a single Web API method call. Note that the maximum number of referral 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 Referral Customer Event Objects | The set of Referral customer events that will be created by this Web API method. Note that the maximum number of referral customer events that can be specified within a single Web API call is 1000 |
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 |
...
| title | bulk referral customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
classification_identifier
(optional)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
referred_rewards_participant_identifier
(mandatory)
...
referred_by_rewards_participant_identifier
(mandatory)
...
external_system
(optional)
...
external_system_reference_number
(optional)
...
The unique reference number of the customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_1
(optional)
...
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
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"referral_customer_events_set":
[
{
"request_unique_identifier":"125",
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"referred_rewards_participant_identifier":{"number":"RP0000000017"},
"referred_by_rewards_participant_identifier":{"number":"RP0000000010"}
},
{
"request_unique_identifier":"124",
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"referred_rewards_participant_identifier":{"number":"RP0000000014"},
"referred_by_rewards_participant_identifier":{"number":"RP0000000012"}
},
{
"request_unique_identifier":"123",
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"referred_rewards_participant_identifier":{"number":"RP0000000004"},
"referred_by_rewards_participant_identifier":{"number":"RP0000000010"}
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Participant RP0000000004 Was Already Referred by Another Participant. - Description:The participant was already referred by another participant.",
"error_code": "ReferredByAnotherParticipantException",
"request_unique_identifier": "123"
}
],
"processed_customer_events_set": [
{
"number": "8",
"id": "D49D8CD39786431F882341CBDE5A254A",
"request_unique_identifier": "125"
},
{
"number": "9",
"id": "94E44BDAF7724C2E97B5C2B533371497",
"request_unique_identifier": "124"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/bulk/social_media/create
This method is used to create multiple social media customer events within a single Web API method call. Note that the maximum number of social media customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
social_media_customer_events_set (mandatory) | Set of Social Media Customer Event Objects | The set of social media customer events that will be created by this Web API method. Note that the maximum number of social media customer events that can be specified within a single Web API call is 1000 |
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 |
...
| title | bulk social media customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(optional)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
social_media
(mandatory)
...
The social media related with the customer event, which can be one of the following: FACEBOOK
...
profile
(mandatory)
...
action
(mandatory)
...
The social media action that was performed. The following actions per social media are supported (if the social media is set to Facebook) LIKE
...
external_system
(optional)
...
external_system_reference_number
(optional)
...
The unique reference number of the customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_1
(optional)
...
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
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"social_media_customer_events_set":
[
{
"request_unique_identifier":"16",
"accounts_receivable_identifier":{"number":"ACR0000000164"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/polina",
"action":"LIKE"
},
{
"request_unique_identifier":"17",
"accounts_receivable_identifier":{"number":"ACR0000000050"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:05:02",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/katerina",
"action":"LIKE"
},
{
"request_unique_identifier":"18",
"accounts_receivable_identifier":{"number":"ACR00045750"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:19:22",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/marios",
"action":"LIKE"
},
{
"request_unique_identifier":"19",
"accounts_receivable_identifier":{"number":"ACR00670000"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:15:42",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/yiannis",
"action":"LIKE"
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR00045750) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "18"
},
{
"error_description": "Error:Account (ACR00670000) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "19"
}
],
"processed_customer_events_set": [
{
"number": "14",
"id": "49A9DF458B6E4DE69CDC7F5E330F34D9",
"request_unique_identifier": "16"
},
{
"number": "15",
"id": "CB54467A5FA445359962283134E1473D",
"request_unique_identifier": "17"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/bulk/web/create
This method is used to create multiple web customer events within a single Web API method call. Note that the maximum number of web 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 Web Customer Event Objects | The set of web customer events that will be created by this Web API method. Note that the maximum number of web customer events that can be specified within a single Web API call is 1000 |
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 |
...
| title | bulk web customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(optional)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
website
(mandatory)
...
external_system
(optional)
...
external_system_reference_number
(optional)
...
The unique reference number of the customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_1
(optional)
...
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
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"web_customer_events_set":
[
{
"request_unique_identifier":"06",
"accounts_receivable_identifier":{"number":"ACR0000000020"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:00:00",
"website":"www.crm.com"
},
{
"request_unique_identifier":"07",
"accounts_receivable_identifier":{"number":"ACR0000000077"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:05:02",
"website":"www.crm.com"
},
{
"request_unique_identifier":"08",
"accounts_receivable_identifier":{"number":"ACR00045000"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:19:22",
"website":"www.crm.com"
},
{
"request_unique_identifier":"09",
"accounts_receivable_identifier":{"number":"ACR00670040"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-06-22T15:15:42",
"website":"www.crm.com"
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR00045000) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "08"
},
{
"error_description": "Error:Account (ACR00670040) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "09"
}
],
"processed_customer_events_set": [
{
"number": "4",
"id": "B50A2C66D9934BF1AC92FB0F963B5654",
"request_unique_identifier": "06"
},
{
"number": "5",
"id": "F85AFE4F8FF64CB4A6C35F234684C8FF",
"request_unique_identifier": "07"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/bulk/financial_achievements/create
This method is used to create multiple financial achievements customer events within a single Web API method call. Note that the maximum number of financial achievements customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
financial_achievement_customer_events_set (mandatory) | Set of Financial Achievement Customer Event Objects | The set of financial achievement customer events that will be created by this Web API method. Note that the maximum number of financial achievement customer events that can be specified within a single Web API call is 1000 |
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 |
...
| title | bulk financial achievement customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(mandatory)
...
product_identifier
(optional)
...
The product of the customer event. Any type of products can be specified. The allowed product identifier fields are the following:
...
payment_medium_type_identifier
(optional)
...
The payment medium type of the customer event. Only payment medium types which are allowed in the related accounts receivable can be specified. The allowed payment medium type identifier fields are the following:
...
payment_medium_type_identifier
(optional)
...
The payment medium brand of the customer event. Only payment medium brands which are allowed in the related accounts receivable can be specified. The allowed payment medium brand identifier fields are the following:
...
payment_medium_identifier
(optional)
...
amount
(optional)
...
The financial achievement customer event amount
| Tip |
|---|
Available from CRM.COM R11.0.0 |
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
external_system
(optional)
...
external_system_reference_number
(optional)
...
The unique reference number of the customer event in the external system
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_1
(optional)
...
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
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"financial_achievement_customer_events_set":
[
{
"request_unique_identifier":"01",
"accounts_receivable_identifier":{"number":"ACR0000000218"},
"classification_identifier":{"name":"Financial Achievement 1"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"amount":"5.50",
"performed_on":"2016-10-07T15:00:00"
},
{
"request_unique_identifier":"02",
"accounts_receivable_identifier":{"number":"ACR0000000226"},
"classification_identifier":{"name":"Financial Achievement 3"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"amount":"11.00",
"performed_on":"2016-10-07T15:00:00"
},
{
"request_unique_identifier":"03",
"accounts_receivable_identifier":{"number":"ACR45000"},
"classification_identifier":{"name":"Financial Achievement 1"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"amount":"12.50",
"performed_on":"2016-10-07T15:00:00"
},
{
"request_unique_identifier":"04",
"accounts_receivable_identifier":{"number":"ACR0000000069"},
"classification_identifier":{"name":"Financial Achievement 2"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"amount":"15.00",
"performed_on":"2016-10-07T15:00:00"
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account (ACR45000) Not Found. - Description:The specified API value was not found.",
"error_code": "NotFoundAPIValueException",
"request_unique_identifier": "03"
}
],
"processed_customer_events_set": [
{
"number": "95",
"id": "6017C1E1D99043588DC21C8C6B4BFACB",
"request_unique_identifier": "01"
},
{
"number": "96",
"id": "393555928D1F4C428FF3C69CA57323F7",
"request_unique_identifier": "02"
},
{
"number": "97",
"id": "566ECA55305941C1AF68ED97A8D56D6F",
"request_unique_identifier": "04"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/bulk/financial_statements/create
| Tip |
|---|
Available from CRM.COM R11.0.0 |
This method is used to create multiple financial statement customer events within a single Web API method call. Note that the maximum number of financial statement customer events that can be created is 1000
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
financial_statement_customer_events_set (mandatory) | Set of Financial Achievement Customer Event Objects | The set of financial achievement customer events that will be created by this Web API method. Note that the maximum number of financial achievement customer events that can be specified within a single Web API call is 1000 |
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 |
...
| title | bulk financial statement customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(mandatory)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
external_system
(optional)
...
Defines the third party system that generated the customer event
...
external_system_reference_number
(optional)
...
Defines the unique reference number of the customer event in the external system
...
udf_string_1
(optional)
...
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
...
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"financial_statement_customer_events_set":
[
{
"request_unique_identifier":"01",
"accounts_receivable_identifier":{"number":"ACR0000000375"},
"classification_identifier":{"alternative_code":"FS"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-10-07T15:00:00",
"period":
{
"period_month":7,
"period_year":2005
},
"measured_key_performance_indicators_set":
[
{
"key_performance_indicator_identifier":{"alternative_code":"kpi_a"},
"value":4,
"product_identifier":{"alternative_code":"IK"}
}
]
},
{
"request_unique_identifier":"02",
"accounts_receivable_identifier":{"number":"ACR0000000375"},
"classification_identifier":{"alternative_code":"FS"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"period":
{
"period_month":6,
"period_year":2005
},
"performed_on":"2016-10-07T15:00:00",
"measured_key_performance_indicators_set":
[
{
"key_performance_indicator_identifier":{"alternative_code":"kpi_a"},
"value":4,
"product_identifier":{"alternative_code":"IK"}
}
]
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"unprocessed_customer_events_set": [
{
"error_description": "Error:Account Sevia92 Already Has Financial Statement Customer Event with Classification Financial Statement for July 2005. - Description:This Account already has financial statement customer event with the same classification, for month year",
"error_code": "AlreadyExistFinancialStateCustomerEventWithSameAcountException",
"request_unique_identifier": "01"
}
],
"processed_customer_events_set": [
{
"number": "33",
"id": "085046F2ACAD4BFFBF2DEF7C0DC79FA8",
"request_unique_identifier": "02"
}
]
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
...
| Panel | ||||
|---|---|---|---|---|
| ||||
|