Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Available from CRM.COM R5.0.0
Tip
Excerpt

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

...

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

(optional)

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

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

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

reference_number

(mandatory)

StringThe reference number of the retrieved purchase customer event

payment_medium_brand_identifier

(optional)

Payment Medium Brand Identifier

The identifier of the payment medium brand with which the purchase customer event has been made. The allowed payment medium brand identifier fields are the following:

Include Page
V4:payment_medium_brand_identifier
V4:payment_medium_brand_identifier

Tip

Available from CRM.COM R10.0.0

payment_medium_type_identifier

(optional)

Payment Medium Type Identifier

The payment medium type with which the purchase customer event has been made. 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 R10.0.0

payment_medium_identifier

(optional)

String

The payment medium identifier with which the purchase customer event has been made

Tip

Available from CRM.COM R10.0.0

external_system

(optional)

String

Defines the third party system that generates the purchase customer event

Tip

Available from CRM.COM R10.0.0

external_system_reference_number

(optional)

String

Defines the reference number that uniquely identifies the purchase customer event in the external system

Tip

Available from CRM.COM R10.1.0

invoice_identifier

(optional)

Invoice IdentifierThe CRM.COM invoice related with the purchase. The allowed invoice identifier fields are the following:

Include Page
V4:invoice_identifier
V4:invoice_identifier

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the customer event. If specified then it is validated against the currency of the related performed by unit (i.e. the default currency) and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Include Page
V4:currency_identifier
V4:currency_identifier

Tip

Available from CRM.COM R11.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_string_9

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_10

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_11

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_12

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_13

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_14

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_15

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_16

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

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

 products_set

(mandatory)

Set of  Purchase Product ObjectsThe purchased products, along with the total amount, net amount and VAT amount for each product

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

Anchor
create purchase customer event referred parameters
create purchase customer event referred parameters
Referred Parameter Objects

...