POST customer_events/bulk/financial_achievements/create

Owned by Former user (Deleted)
Last updated: May 21, 2019 by Joseph Ioannou (Unlicensed)
4 min read

Available from CRM.COM R10.0.0

Deprecated from CRM.COM R15.0.0 onwards. This functionality will be provided through achievement customer events

This method is used to create multiple financial achievements customer events within a single Web API method call. Note that the maximum number of financial achievements customer events that can be created is 1000

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

(semi-optional)

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

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe 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

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the rewards participant. Only effective access tokens can be used to identify a rewards participant. 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

classification_identifier

(mandatory)

Customer Event Classification IdentifierThe classification of the customer event. Only financial achievement 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

product_identifier

(optional)

Product Identifier

The product of the customer event. Any type of products can be specified. 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

payment_medium_type_identifier

(optional)

Payment Medium Type Identifier

The payment medium type of the customer event. Only payment medium types which are allowed in the related accounts receivable can be specified. The allowed payment medium type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the payment medium type

name

(semi-optional)

String

The name of the payment medium type

alternative_code

(semi-optional)

String

The alternative code of  the payment medium type

payment_medium_brand_identifier

(optional)

Payment Medium Type Identifier

The payment medium brand of the customer event. Only payment medium brands which are allowed in the related accounts receivable can be specified. The allowed payment medium brand identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the payment medium brand

name

(semi-optional)

String

The name of the payment medium brand

alternative_code

(semi-optional)

String

The alternative code of  the payment medium brand

payment_medium_identifier

(optional)

StringThe payment medium identifier of the customer event.

amount

(optional)

Number

The financial achievement customer event amount

Available from CRM.COM R11.0.0

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)

StringThe third party system that generates the customer event

external_system_reference_number

(optional)

String

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

Available from CRM.COM R10.1.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


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_achievement_customer_events_set":
   [
        {
            "request_unique_identifier":"01",
            "accounts_receivable_identifier":{"number":"ACR0000000218"},
            "classification_identifier":{"name":"Financial Achievement 1"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "amount":"5.50",
            "performed_on":"2016-10-07T15:00:00"
        },
        {
            "request_unique_identifier":"02",
            "accounts_receivable_identifier":{"number":"ACR0000000226"},
            "classification_identifier":{"name":"Financial Achievement 3"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "amount":"11.00",
            "performed_on":"2016-10-07T15:00:00"
        },
        {
            "request_unique_identifier":"03",
            "accounts_receivable_identifier":{"number":"ACR45000"},
            "classification_identifier":{"name":"Financial Achievement 1"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "amount":"12.50",
            "performed_on":"2016-10-07T15:00:00"
        },
        {
            "request_unique_identifier":"04",
            "accounts_receivable_identifier":{"number":"ACR0000000069"},
            "classification_identifier":{"name":"Financial Achievement 2"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "amount":"15.00",
            "performed_on":"2016-10-07T15:00:00"
        }
    ]
 }


Response:

 {
  "data": {
    "unprocessed_customer_events_set": [
      {
        "error_description": "Error:Account (ACR45000) Not Found. - Description:The specified API value was not found.",
        "error_code": "NotFoundAPIValueException",
        "request_unique_identifier": "03"
      }
    ],
    "processed_customer_events_set": [
      {
        "number": "95",
        "id": "6017C1E1D99043588DC21C8C6B4BFACB",
        "request_unique_identifier": "01"
      },
      {
        "number": "96",
        "id": "393555928D1F4C428FF3C69CA57323F7",
        "request_unique_identifier": "02"
      },
      {
        "number": "97",
        "id": "566ECA55305941C1AF68ED97A8D56D6F",
        "request_unique_identifier": "04"
      }
    ]
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}