Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R10.0.0

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


Excerpt

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

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

...

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

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

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:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

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:

Include Page
V4:product_identifier
V4:product_identifier

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:

Include Page
V4:payment_medium_type_identifier
V4:payment_medium_type_identifier

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

Include Page
V4:payment_medium_brand_identifier
V4:payment_medium_brand_identifier

payment_medium_identifier

(optional)

StringThe payment medium identifier of the customer event.

amount

(optional)

Number

The financial achievement customer event amount

Tip

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:

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

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

Tip

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


...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

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

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


...