POST customer_events/financial_statements/list
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
- p_demou (Deactivated)
Available from CRM.COM R11.0.0
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) | Rewards Participant Identifier | The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
Deprecated from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
| accounts_receivable_identifier (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:
From CRM.COM R17.0.0, the access token attributes are supported | ||||||||||||||||||||||||||||||
| classification_identifier (semi-optional) | Customer Event Classification Identifier | 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:
| ||||||||||||||||||||||||||||||
created_after_date (semi-optional) | Date | If specified then information related with customer events that was created after the specified date should be retrieved Available from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
created_before_date (optional) | Date | If specified then information related with customer events that was created before the specified date should be retrieved Available from CRM.COM R17.0.0 | ||||||||||||||||||||||||||||||
submitted_after_date (optional) | Date | if specified then information related with financial statements customer events that was submitted after the specified date should be retrieved Available from CRM.COM R12.2.0 | ||||||||||||||||||||||||||||||
submitted_before_date (optional) | Date | if specified then information related with financial statements customer events that was submitted before the specified date should be retrieved Available from CRM.COM R12.2.0 | ||||||||||||||||||||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 | ||||||||||||||||||||||||||||||
offset (optional) | Number | 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 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
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved financial statement customer event |
| number | String | The number of the retrieved financial statement customer event |
| type | String | The type of the retrieved financial statement customer event which in this case is set to FINANCIAL_STATEMENT |
| 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 |
| external_system | String | Defines the third party system that generated the customer event |
| external_system_reference_number | String | Defines the unique reference number of the customer event in the external system |
| total_awarded_amount | Number | The total amount that was awarded for that purchase customer event in system currency Available from CRM.COM R13.1.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 |
| 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_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 |
| period | Financial Statement Period Object | The period which was measured by the retrieved financial statement customer event |
| 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 with the retrieved customer event | |
| award_reward_transactions_set | Set of Award Reward Transaction Object | The award reward transactions that were created as a result of the financial statement customer event |
| measured_key_performance_indicators_set | Set of Measured Key Performance Indicators Objects | The set of key performance indicators that were measured by the retrieved financial statement customer event |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000376"},
"classification_identifier":{"alternative_code":"FS"}
}
Response:
{
"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": ""
}
}
HTTP Method: POST
Request:
Body:
{
"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:
{
"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": ""
}
}