purchase_customer_event_create_spend_parameters

purchase customer event create-spend parameter object data

Name

Type

Description

classification_identifier

(optional)

Customer Event Classification Identifier

The classification of the customer event. 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

description

(optional)

String

A description of the customer event

reference_number

(mandatory)

String

The reference number of the retrieved purchase customer event

external_system_reference_number

(optional)

String

Defines the unique reference number of the purchase customer event in the external system

Available from CRM.COM R10.1.0

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.

If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium brand as specified in the related access token classification

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

Available from CRM.COM R10.0.0

payment_medium_type_identifier

(optional)

Payment Medium Type Identifier

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

If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium type as specified in the related access token classification

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

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

Available from CRM.COM R10.0.0

invoice_identifier

(optional)

Invoice Identifier

The CRM.COM invoice related to the purchase. The allowed invoice identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the invoice
number (semi-optional)	String	The number of the invoice
reference_number (semi-optional)	String	The reference number of the invoice
back_office_code (semi-optional)	String	The back office code of the invoice Available from CRM.COM R9.1.0

promo_code

(optional)

String

The effective, not expired promo code that can be used on the customer event. The promo code is validated against its related promotion campaign's settings in order to be provided.

Available from CRM.COM R15.0.0

disable_instant_spend

(optional)

Boolean

It determines if instant spend offers should be disabled (i.e. not applied) or not. By default all instant spend offers are applied if their conditions are met.

Available from CRM.COM R14.4.0

terminal_identifier

(optional)

String

An identifier of the terminal that submitted the purchase customer event

Available from CRM.COM R15.1.0

total_discount_amount

Number

The total discount made on the purchase customer event

Available from CRM.COM R16.10.0

udf_string_1

(optional)

String