Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Available from CRM.COM R11.0.0

Excerpt

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

...

titlebulk financial statement customer event parameter object data

...

Name

...

Type

...

Description

...

request_unique_identifier

(mandatory)

...


Tip

Available from CRM.COM R11.0.0


Excerpt

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

Anchor
bulk create financial statement parameters
bulk create financial statement parameters
Referred Parameter Objects


The classification of the customer event. Only financial statement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:
The unit that initiated the customer event. The allowed unit identifier fields are the following:
V4:unit_identifier
Expand
titlebulk 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:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

Tip

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:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

Tip

Deprecated from CRM.COM R17.0.0


classification_identifier

(mandatory)

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

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_business_unit_identifier

(semi-optional)

Accounts receivable
Business Unit Identifier
The
related accounts receivable
business unit that initiated the customer event. The allowed
accounts receivable
identifier fields are the following
:

Include Page
V4:

accounts

business_

receivable

unit_identifier
V4:

accounts

business_

receivable

unit_identifier

rewards_participant

Tip

Available from CRM.COM R18.0.0


performed_by_unit_identifier

(semi-optional)

Rewards Participant
Unit Identifier
The
related rewards participant
unit that initiated the customer event. The allowed
rewards participant
identifier fields are the following
:

Include Page
V4:

rewards_participants_identifier
V4:rewards_participants_identifier

classification_identifier

(mandatory)

Customer Event Classification Identifier
Include Page
V4:customer_event_classification_identifierV4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit Identifier
Include Page
V4:unit_identifier

unit_identifier
V4:unit_identifier

Tip

For releases prior CRM.COM R17.0.0, this attribute was mandatory

From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_device_identifier is specified

Deprecated from CRM.COM R18.0.0


performed_by_tap_identifier

(semi-optional)

Transaction Acquiring Point Identifier

The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following

Include Page
V4:transaction_acquiring_point_identifier
V4:transaction_acquiring_point_identifier

Tip

Available from CRM.COM R17.0.0

From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_unit_identifier is specified

From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_business_unit_identifier is specified


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

Anchor
create financial statement customer event referred parameters
create financial statement customer event referred parameters
Referred Parameter Objects

Include Page
V4:financial_statement_period_parameters
V4:financial_statement_period_parameters

Include Page
V4:financial_statement_customer_event_measured_KPI_parameters
V4:financial_statement_customer_event_measured_KPI_parameters

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
  "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:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
  "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": ""
  }
}


...