Versions Compared

Key

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

This method is used to create an achievement customer event in a posted life cycle state

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

accounts_receivable_identifier

(semi-optional)

...

Excerpt

This method is used to create an achievement customer event in a posted life cycle state

Resource URL

Parameters

V4:customer_event_classification_identifier

Name

Type

Description

token

String

The token retrieved from the login method

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

classification_identifier

(mandatory)

Customer Event Classification IdentifierThe 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:accounts_receivable_identifierV4:accounts_receivable_identifier
rewards_participant
payment_medium_type_identifier

Tip

Available from CRM.COM R15.0.0

payment_medium_brand_identifier

(semi-optional)

Rewards Participant Payment Medium Brand Identifier

The

related rewards participant

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

rewards participant

payment medium brand identifier fields are the following:

Include Page
V4:rewardspayment_medium_participantsbrand_identifier
V4:rewardspayment_medium_participantsbrand_identifier
classification

Tip

Available from CRM.COM R15.0.0

payment_medium_identifier

(mandatoryoptional)

Customer Event Classification IdentifierString

The

classification

payment medium identifier of the customer event.

Tip

Available from CRM.

The allowed customer event classification identifier fields are the following:
Include Page
V4:customer_event_classification_identifier

COM R15.0.0

amount

(optional)

Number

The achievement customer event's amount

Tip

Available from CRM.COM R15.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)

String

The third party system that generates the customer event

Tip

Available from CRM.COM R10.0.0

external_system_reference_number

(optional)

String

The external system's unique reference number of customer event

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

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

Tip

Available from CRM.COM R10.0.0

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...