Skip to end of banner
Go to start of banner

POST customer_events/bulk/financial_statements/create

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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

Referred Parameter Objects


 bulk financial statement customer event parameter object data

Name

Type

Description

request_unique_identifier

(mandatory)

StringA unique identifier of the request, provided by the caller, in order to identify the successful or failed results. Note that this information should be unique and is not stored within CRM.COM

accounts_receivable_identifier

(mandatory)

Accounts receivable Identifier

The related accounts receivable. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. The allowed access token identifier fields are the following

Name

Type

Description

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

StringThe identifier of the access token. If the identifier is specified then it will be validated against the specified pass code

pass_code

(mandatory on conditions)

StringThe pass code of the access token, which is applicable and mandatory if the identifier is specified

one_time_password

(semi-optional)

Integer

The one-time password (OTP) of the access token

Available from CRM.COM R13.0.0

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0

For releases prior CRM.COM R17.0.0, this field was semi-optional

From CRM.COM R17.0.0, the access token attributes are supported

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier
The related rewards participant. The allowed rewards participant identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the rewards participant

number

(semi-optional)

String

The number of the rewards participant

Deprecated from CRM.COM R17.0.0

classification_identifier

(mandatory)

Customer Event Classification IdentifierThe classification of the customer event. Only financial statement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event classification

name

(semi-optional)

String

The name of the customer event classification

alternative_code

(semi-optional)

String

The alternative code of  the customer event classification

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of  the Unit

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

external_system

(optional)

String

Defines the third party system that generated the customer event


external_system_reference_number

(optional)

String

Defines the unique reference number of the customer event in the external system

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_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

period

(mandatory)

Financial Statement Period ObjectThe period which is measured by the financial statement customer event

measured_key_performance_indicators_set

(mandatory)

Set of Measured Key Performance Indicator ObjectsThe set of key performance indicators that will be measured by the financial statement customer event

Referred Parameter Objects

 financial statement period parameter object data

Name

Type

Description

month

(mandatory)

Integer

The month of the retrieved period

year

(mandatory)

Integer

The year of the retrieved period

 measured key performance indicator parameter object data

Name

Type

Description

key_performance_indicator_identifier

(mandatory)

Key Performance Indicator identifierThe key performance indicator that will be measured. The allowed key performance indicator identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event key performance indicator

name

(semi-optional)

String

The name of the customer event key performance indicator

alternative_code

(semi-optional)

String

The alternative code of  the customer event key performance indicator

value

(mandatory)

NumberThe value of the measured key performance indicator

product_identifier

(optional)

Products identifierThe product that will be measured by the key performance indicator. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

Response Data

Name

Type

Description

processed_customer_events_set

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

 processed customer event object response data

Name

Type

Description

request_unique_identifierStringA unique identifier of the request, as provided by the caller, in order to identify the successful results.

id

String

The ID of the customer event that was created

number

String

The number of the customer event that was created

 unprocessed customer event object response data

Name

Type

Description

request_unique_identifierStringA unique identifier of the request, as provided by the caller, in order to identify the failed results.
error_code

String

The code of the error that was raised

error_descriptionString

The description of the error that was raised

Examples

 Example 1

HTTP Method: POST


Request:

Body:

{
  "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":
           {
             "month":10,
             "year":2016
           },
           "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"},
           "performed_on":"2016-10-07T15:00:00",
           "period":
           {
             "month":10,
             "year":2016
           },
           "measured_key_performance_indicators_set":
              [
                    {
                        "key_performance_indicator_identifier":{"alternative_code":"kpi_a"},
                        "value":15
                    }
                ]
       },
       {
           "request_unique_identifier":"03",
           "accounts_receivable_identifier":{"number":"ACR0000000375"},
           "classification_identifier":{"alternative_code":"FS"},
           "performed_by_unit_identifier":{"name":"Admin Unit"},
           "period":
            {
             "month":11,
             "year":2016
           },
           "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"}
                    },
                    {
                        "key_performance_indicator_identifier":{"alternative_code":"kpi_a"},
                        "value":10
                    }
                ]
       }
   ]
}


Response:

{
  "data": {
    "unprocessed_customer_events_set": [
      {
        "error_description": "Error:Account Sevia92 Already Has Financial Statement Customer Event with Classification Financial Statement for October 2016. - Description:This Account already has financial statement customer event with the same classification, for month year",
        "error_code": "AlreadyExistFinancialStateCustomerEventWithSameAcountException",
        "request_unique_identifier": "02"
      }
    ],
    "processed_customer_events_set": [
      {
        "number": "125",
        "id": "2E6FF58B2E45421182E7991508232254",
        "request_unique_identifier": "01"
      },
      {
        "number": "126",
        "id": "74CD8564EACC48C2B1543E5030A1406A",
        "request_unique_identifier": "03"
      }
    ]
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
  • No labels