Versions Compared

Old Version 6

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

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.


Tip

Available from CRM.COM R10.0.0

Excerpt

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

achievement_customer_events_set

(mandatory)

...

Set of Achievement Customer Event Objects

...

The set of achievement customer events that will be created by this Web API method

Note that the maximum number of 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 achievement customer event parameter object data

...

Name

...

Type

...

Description

...

request_unique_identifier

(mandatory)

...

accounts_receivable_identifier

(mandatory)

...


Tip

Available from CRM.COM R10.0.0


Excerpt

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

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

achievement_customer_events_set

(mandatory)

Set of Achievement Customer Event Objects

The set of achievement customer events that will be created by this Web API method

Note that the maximum number of 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 achievements parameters
bulk create achievements parameters
Referred Parameter Objects

The classification of the customer event. The allowed customer event classification identifier fields are the following:
Available

Expand
titlebulk achievement customer event parameter object data


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

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

Tip

Available from CRM.COM R15.0.0


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

Tip

Available from CRM.COM R15.0.0


payment_medium_brand_identifier

(optional)

Payment Medium Brand 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:accountspayment_medium_receivablebrand_identifier
V4:accounts_receivable_identifier

Tip

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

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier
Include Page
V4:rewards_participants_identifierV4:rewards_participants_identifier
Tip

Deprecated from CRM.COM R17.0.0

classification_identifier

(mandatory)

Customer Event Classification Identifier
Include Page
V4:customer_event_classification_identifierV4: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_identifierV4:productpayment_medium_brand_identifier

Tip

Available from CRM.COM R15.0.0


payment_medium_identifier

(optional)

String

The payment medium identifier of the customer event.

Tip

Available from CRM.COM R15.0.0


amount

(optional)

Number

The achievement customer event's amount

Tip

Available from CRM.COM R15.0.0


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 R15R18.0.0


paymentperformed_mediumby_typeunit_identifier

(semi-optional)

Payment Medium Type Unit Identifier
The payment medium type of the customer event. Only payment medium types which are allowed in the related accounts receivable can be specifiedunit that initiated the customer event. The allowed payment medium type identifier fields are the following:

Include Page
V4:payment_medium_typeunit_identifier
V4:payment_medium_type_identifier

Tip
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 R15R18.0.0


paymentperformed_mediumby_brandtap_identifier

(semi-optional)

Payment Medium Brand IdentifierThe payment medium brand of Transaction Acquiring Point Identifier

The unit's transaction acquiring point that initiated 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:paymenttransaction_mediumacquiring_brandpoint_identifier
V4:paymenttransaction_mediumacquiring_brandpoint_identifier

Tip

The payment medium identifier of the customer event.

Tip

Available from CRM.COM R15R17.0.0

payment_medium_identifier

(optional)

String

The achievement customer event's amount

Tip

Available from CRM.COM R15.0.0

Available from From CRM.COM R15R17.0.0

amount

(optional)

Number

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

unit_identifier

(mandatory)

Unit Identifier
The unit that initiated the customer event. The allowed unit identifier fields are the following:
Include PageV4:unit_identifierV4:unit_identifier

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)

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


...