Versions Compared

Old Version 3

changes.mady.by.user p_demou

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

...


Tip

Available from CRM.COM R11.0.0


Excerpt

This method is used to create a financial statement customer event in a posted life cycle state

Resource URL

Parameters

The related accounts receivable

Name

Type

Description

token

String

The token retrieved from the login method

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

From CRM.COM R18.0.0, the access token attributes are deprecated


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

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_business_unit_identifier

(semi-optional)

Business Unit Identifier
The business unit that initiated the customer event. The allowed identifier fields are the following

Include Page
V4:business_unit_identifier
V4:business_unit_identifier

Tip

Available from CRM.COM R18.0.0


performed_by_unit_identifier

(semi-optional)

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

Include Page
V4: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)

Accounts receivable Identifier
Transaction Acquiring Point Identifier

The unit's transaction acquiring point that initiated the customer event. The allowed

accounts receivable

identifier fields are the following

:

Include Page
V4:

accounts

transaction_acquiring_

receivable

point_identifier
V4:

accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:
Include PageV4:rewards_participants_identifierV4:rewards_participants_identifier

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:
Include PageV4:customer_event_classification_identifierV4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit

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




authorized_by_access_token_identifier

(optional)

Access Token Identifier

The access token that was used to identify and authorized the customer. This information will be overridden if the customer was identified via an access token through this Web API call. The allowed access token identifier fields are the following:

Include Page
V4:

unit_identifierV4:unit_identifier

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)

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

access_token_identifier
V4:access_token_identifier

Tip

Available from CRM.COM R15.0.0

Deprecated from CRM.COM R18.0.0


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

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
create financial statement customer event referred parameters
create financial statement customer event referred parameters
Referred Parameter Objects

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

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


...