Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the retrieved purchase customer event

number

String

The number of the retrieved purchase customer event

typeStringThe type of the retrieved purchase customer event which in this case is set to PURCHASE
life_cycle_stateStringThe life cycle state of the customer event which can be POSTED or CANCELLED
performed_onDateThe date that the customer event was actually performed
descriptionStringA description of the customer event
process_immediatelybooleanDefines if the customer event was processed immediately by various business processes or not
reference_numberStringThe reference number of the retrieved purchase customer event
payment_medium_identifierString

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

Tip

Available from CRM.COM R10.0.0

total_amountNumberThe total amount of the retrieved purchase customer event
net_amountNumberThe total net amount of the retrieved purchase customer event
vat_amountNumberThe total VAT amount of the retrieved purchase customer event
external_systemString

Defines the third party system that generated the retrieved purchase customer event

Tip

Available from CRM.COM R10.0.0

external_system_reference_numberString

Defines the unique reference of the external system that uniquely identifies the purchase customer event4

Tip

Available from CRM.COM R10.1.0

total_awarded_amountNumber

The total amount that was awarded for that purchase customer event

Tip

Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward

total_spend_amountNumber

The total amount that was spent on that purchase customer event. The total spend amount = Total instant spend amount + Total automatic spend amount + Total additional spend amount

Tip

Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward

 total_instant_spend_amount Number

 The total amount that was spent instantly on that purchase customer event

Tip

Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward

 total_automatic_spend_amount Number

 The total amount that was spent automatically on that purchase customer event, if the automatic awards spending is allowed

Tip

Available from CRM.COM R13.1.0

 total_additional_spend_amount Number

 The total amount that was spent automatically on that purchase customer event, if the automatic awards spending is allowed

Tip

Available from CRM.COM R12.2.0 and CRM.COM R13.1.0 onward


udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_10

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_11

 

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_12

 

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_13

 

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_14

 

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_15

 

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_string_16

 

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

classificationCustomer Event Classification ObjectThe classification of the customer event
accounts_receivableAccounts receivable ObjectThe related accounts receivable
performed_by_unitUnit ObjectThe unit that initiated the customer event

log_information

Log Information Object

The log information related with the retrieved invoice

invoiceInvoice ObjectThe CRM.COM invoice related with the purchase
instant_spend_requestSpend Request Customer Event Object

The spend request customer event that was created instantly while processing and awarding the purchase customer event]

Tip

Available from CRM.COM R10.0.0

automatic_spend_requestSpend Request Customer Event Object

The spend request customer event that was created automatically as part of the automatic awards spending process

Tip
 Available from CRM.COM R13.0.0
currencyCurrency Object

The purchase customer event's related currency

Tip

Available from CRM.COM R10.0.0

payment_medium_brandPayment Medium Brand Object

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

Tip

Available from CRM.COM R10.0.0

payment_medium_typePayment Medium Brand Object

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

Tip

Available from CRM.COM R10.0.0

products_setSet of  Purchase Product ObjectsThe purchased products, along with the total amount, net amount and VAT amount for each product
award_reward_transactions_setSet of Award Reward Transaction ObjectThe award reward transactions that were created as a result of the purchase customer event
spend_requests_setSet of Spend Request Customer Event Objects

The spend request customer events that were submitted against the purchase customer event

Tip

Available from CRM.COM R13.0.0

Anchor
purchase customer event referred objects
purchase customer event referred objects
Referred Objects Response Data

...