Refund event (optional)

Overview:

A refund event occurs when a cancellation (full or partial) of a purchase occurs, and a user benefits from a refund of the corresponding paid amount. Another common term used for this used in physical commerce is return.
The primary key is refund_id+ refund_line_id (one line per refund act and product refunded).
ℹ️ Refunds cannot be updated
ℹ️ For returns (or refunds) lines, amounts and quantities are to be signed negatively (opposite sign from the initial purchase line) while the unit price remains positive.
ℹ️ In the case sales are operated in many currencies, monetary information should be transmitted both for base currency (used for reporting purposes) and presentment currency (the currency in which the sale was done, and that can be used for personalization purposes).

Fields list

Field name	Type	Kind	Definition	Value example
refund_id	String	Mandatory	The refund identifier (can be an order_id, a ticket_id, ...).	312
user_id	String	Mandatory	The user id who was refunded.	2356
store_id	String	Mandatory	The store id in which the refund was recorded.	23
event_datetime	Date or Datetime	Mandatory	The date or datetime the refund occured.	2023-07-08T18:34:26+01:00
refunded_purchase_id	String	Optional	If available, thepurchase reference that was refunded
base_currency	String	Mandatory	The reference currency used for operations. Is to be the same for all refunds and purchases. It is the currency that will be used for reporting purposes.	EUR
total_paid_amount	Decimal	Mandatory	The total amount refunded to the user for the refund (including the total discount+shipping+tax_amount).	-53.00
total_discount_amount	Decimal	Mandatory	The discount amount for the refund	0.00
total_shipping_amount	Decimal	Mandatory	The shipping amount for the refund	0.00
total_tax_amount	Decimal	Mandatory	The tax amount for the refund	-10.06
presentment_currency	String	Optional	In case of operations in more than one currency, the file must also contain the refund's currency and money information in the currency the refund was done.	USD
presentment_total_paid_amount	Decimal	Optional	The total amount refunded to the user (including the total discount +shipping+tax amount), in the presentment currency	-59.33
presentment_total_discount_amount	Decimal	Optional	The total discount amount for the refund, in the presentment currency	0.00
presentment_total_shipping_amount	Decimal	Optional	The shipping amount for the refund, in the presentment currency	0.00
presentment_total_tax_amount	Decimal	Optional	The tax amount for the refund, in the presentment currency	-11.87
card_code	String	Optional	In case there is a loyalty program, the card code to which the refund is attached.
refund_line_id	String	Mandatory	The unique identifier for the refund line	312-812
refunded_purchase_line_id	String	Mandatory	If available, the unique identifier of the purchase line that was refunded
product_id	String	Mandatory	The id of the product that was refunded.	812
quantity	Decimal	Mandatory	The quantity refunded.	-1.20
unit	String	Mandatory	The unit in which the quantity is expressed. In the case when the quantity is simply a number of items, the unit can be left empty.	meters
unit_price	Decimal	Mandatory	The unit price for the product refunded.	5.60
line_paid_amount	Decimal	Mandatory	The amount paid for the line (including discount+shipping+tax)	-6.72
line_shipping_amount	Decimal	Mandatory	The shipping cost for the line	0.00
line_discount_amount	Decimal	Mandatory	The discount amount for the line	0.00
line_tax_amount	Decimal	Mandatory	The tax amount for the line	0.00
presentment_unit_price	Decimal	Optional	The unit price for the product refunded, in the presentment currency.	-6.28
presentment_line_paid_amount	Decimal	Optional	The amount refunded for the line (including the line discount +shipping+tax amount), in the presentment currency.	-7.54
presentment_line_shipping_amount	Decimal	Optional	The shipping cost for the line, in the presentment currency.	0.00
presentment_line_discount_amount	Decimal	Optional	The discount amount for the line, in the presentment currency.	0.00
presentment_lint_tax_amount	Decimal	Optional	The tax amount for the line, in the presentment currency	-1.50
{custom attribute}	Any type	Optional	Any other purchase-related attribute of interest to making it available in Splio solutions.