| Tip |
|---|
Available from CRM.COM R11.0.0 |
Table of Contents maxLevel 2
GET customer_events/financial_statements/show
This method returns information related with a financial statement customer event. A single financial statement customer event is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Customer Event identifier
The identifier of the customer event that should be returned as a result. Only customer events of type financial statement can be specified. The allowed customer event 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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST customer_events/financial_statements/list
This method returns information related with financial statements customer events. Multiple financial statements customer events are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
rewards_participant_identifier
(semi-optional)
...
(semi-optional)
...
Accounts Receivable Identifier
The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
...
(semi-optional)
...
The identifier of the classification related with the customer events that should be retrieved. Only financial statement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:
...
submitted_after_date
(optional)
...
if specified then information related with financial statements customer events that was submitted after the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
submitted_before_date
(optional)
...
if specified then information related with financial statements customer events that was submitted before the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Multiple parameters are allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000376"},
"classification_identifier":{"alternative_code":"FS"}
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"external_system_reference_number": null,
"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-10-13T15:20:30",
"updated_date": "2016-10-13T15:21:19",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
}
},
"description": null,
"udf_date_2": null,
"type": "FINANCIAL_STATEMENT",
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "18",
"udf_float_3": null,
"udf_float_4": null,
"award_reward_transactions_set": null,
"id": "747370B6C3D5488ABD5D6C3BC0D23334",
"udf_float_1": null,
"udf_float_2": null,
"measured_key_performance_indicators_set": [
{
"key_performance_indicator": {
"alternative_code": "kpi_a",
"name": "key performance indicator A",
"id": "164DC042D50F462BB6B28E86AE2B6C8C"
},
"product": {
"code": "InstaKit",
"alternative_code": "I",
"description": "InstaKit",
"id": "EF503D536E544E01BD770A85309E90A5"
},
"id": "48EDC1FC802D48AC897A847DC8FA82C1",
"value": 8
},
{
"key_performance_indicator": {
"alternative_code": "ETKPI",
"name": "ET KPI",
"id": "123456id"
},
"product": {
"code": "PK_SmartCard",
"alternative_code": "P_8",
"description": "PK_SmartCard",
"id": "2ED97CB3DC0141C5B8316525B9D54AB7"
},
"id": "7B47E2BE54D849969CC77E0B56A9AAE8",
"value": 6
}
],
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"period": {
"month": "May",
"year": 2016
},
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000376",
"name": "Sevia24",
"id": "2D06EDAFDFD34C59876DB135FB7FE820",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "sevia kyriacou",
"last_name": "kyriacou",
"id": "ADBFCA4396394F638302E94C40B05A81",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "sevia",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": "FEMALE",
"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-10-13T15:20:30",
"classification": {
"alternative_code": "FS",
"name": "Financial Statement",
"id": "DF940370AA0D4497AA33F1A89A842C62"
},
"process_immediately": false,
"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,
"external_system": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000659"},
"fields_set": "number,performed_on",
"submitted_after_date":"2016-10-26T00:00:12",
"submitted_before_date":"2016-11-03T15:00:12"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"number": "10",
"performed_on": "2016-10-26T15:00:00"
},
{
"number": "6",
"performed_on": "2016-10-26T15:00:00"
},
{
"number": "8",
"performed_on": "2016-10-26T15:00:00"
},
{
"number": "9",
"performed_on": "2016-10-26T15:00:00"
},
{
"number": "7",
"performed_on": "2016-10-26T15:00:00"
},
{
"number": "26",
"performed_on": "2016-10-26T15:00:00"
},
{
"number": "91",
"performed_on": "2016-11-01T00:00:00"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/financial_statements/create
This method is used to create a financial statement 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
(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
...
(mandatory)
...
measured_key_performance_indicators_set
(mandatory)
...
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
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000375"},
"classification_identifier":{"alternative_code":"FS"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2016-10-07T15:00:00",
"description":"Testing creation of financial statement customer event through API",
"period":
{
"month":7,
"year":2016
},
"measured_key_performance_indicators_set":
[
{
"key_performance_indicator_identifier":{"alternative_code":"kpi_a"},
"value":4,
"product_identifier":{"alternative_code":"IK"}
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"external_system_reference_number": null,
"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-10-19T14:46:22",
"updated_date": "2016-10-19T14:46:22",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
}
},
"description": "Testing creation of financial statement customer event through API",
"udf_date_2": null,
"type": "FINANCIAL_STATEMENT",
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "124",
"udf_float_3": null,
"udf_float_4": null,
"award_reward_transactions_set": null,
"id": "280672C641AF4FCAAA8B8FC8E84AA407",
"udf_float_1": null,
"udf_float_2": null,
"measured_key_performance_indicators_set": [
{
"key_performance_indicator": {
"alternative_code": "kpi_a",
"name": "key performance indicator A",
"id": "164DC042D50F462BB6B28E86AE2B6C8C"
},
"product": {
"code": "Installation Kit",
"product_type": {
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "IK",
"composition_method": "FIXEDBUNDLE",
"name": "Installation Kit",
"description": "Provisioning Installation kit that can include traceable and non traceable products",
"id": "380C41872DA048DEB1D57CF67D7550F6",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "IK",
"description": "Installation Kit",
"id": "D970FFF8F63F4A489108FB60A69657D1"
},
"id": "393FC96FD9604F5CA64767F21DCC3A0E",
"value": 4
}
],
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"period": {
"month": 7,
"year": 2016
},
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000375",
"name": "Sevia92",
"id": "04C5470CED9248B58FB7E126C9F1E9CB",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "sevia kyriacou",
"last_name": "kyriacou",
"id": "ADBFCA4396394F638302E94C40B05A81",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "sevia",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": "FEMALE",
"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-10-07T15:00:00",
"classification": {
"alternative_code": "FS",
"name": "Financial Statement",
"id": "DF940370AA0D4497AA33F1A89A842C62"
},
"process_immediately": false,
"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,
"external_system": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/financial_statements/cancel
This method is used in order to cancel a posted financial statement customer event. This method can be applied only on posted financial statement customer events. A single financial statement customer event can be cancelled by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
customer_event_identifier
(mandatory)
...
Customer Event identifier
The identifier of the customer event that should be cancelled. Only customer events of type financial statement which are posted can be specified. The allowed customer event identifier fields are the following:
...
fields_set
(optional)
...
Response Data
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"customer_event_identifier":{"number":"124"}
} |
Response:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
| name | blue |
|---|
| Child pages (Children Display) | ||
|---|---|---|
|