Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 7
Next »
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 (optional) | 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 |
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: 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 |
|
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 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 |
|
payment_medium_identifier (optional) | String | The payment medium identifier with which the purchase customer event has been made |
invoice_identifier (optional) | Invoice Identifier | The CRM.COM invoice related with 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 |
|
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 |
products_set (mandatory) | Set of Purchase Product Objects | The purchased products, along with the total amount, net amount and VAT amount for each product |
Referred Parameter Objects
purchase customer event product parameter object data
Name | Type | Description |
product_identifier (mandatory) | Products Identifier | The purchased product. The allowed product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
quantity (optional) | Number | The quantity of the specified purchase customer event product. If not specified then it automatically defaults to 1
|
net_amount (mandatory) | Number | The net amount of the specified purchase customer event product |
vat_amount (mandatory) | Number | The VAT amount of the specified purchase customer event product |
total_amount (mandatory) | Number | The total amount of the specified purchase customer event product |