Clearing supplement file fields

The Clearing supplement file contains transaction-level data that can be used for reconciliation, analytics, and integration into your internal systems.

The following fields are available in the file:

Field	Explanation
Purchase Id	Unique identifier of the purchase. Called reference number in all communication with customers.
Running No	Consecutive number given to each item of a purchase.
Invoice Id	Invoice no. of the invoice of the customer.
Invoice Day	Invoice date of the invoice of the customer.
Reimbursement Id	Unique identifier of a follow-up transaction for a purchase, for example, a refund or retrospective discount.
Purchase Status	Status of the purchase at the time of generation of the clearing report. For descriptions of the values, see Purchase Status.
Purchase Status Notification Id	Purchase status code as submitted in the element of the client notification. For details on what these codes stand for, see Purchase Status.
Report Type	Type of the transaction. This is either a purchase or a reimbursement. A reimbursement is a follow-up transaction for a purchase.
Report Day	For purchases, the date on which the payment arrived. For reimbursements, the date on which the follow-up transaction occurred.
Report Time	For purchases, the date and time when the payment arrived. For reimbursements, the date and time when the follow-up transaction occurred.
Payment Arrive Time	Date and time when the payment for a purchase arrived.
Reimbursement Time	Date and time when the follow-up transaction for a purchase occurred.
Customer Currency Id	Currency in which the customer purchased the product.
Subscription Interval No	It is the serial number of the renewal activity for a subscription. It is equal to 0 for the signing of subscription and autoincrements +1 each time of renewing
Subscription Item Interval No	It is the serial number of the renewal activity for a subscription item. It is equal to 0 for the signing of subscription and autoincrements +1 each time of renewing
Subscription Id	It is the unique identifier of subscription. Subscription is a product that is billed at regular intervals, such as monthly or yearly. Each subscription item should be related to the purchase item but not each purchase item should be related to the subscription item. If the deal is a one-time deal and does not set up renewal policy this is just purchase. So, in this case the fields related to subscription can be empty
Recurring Interval	It is the value of days or months for the regular subscription interval.
Subscription Next Billing Time	It is the date when the next payment is expected (renewal) for any active subscription items related to the subscription.
Payment Type	Payment type of the purchase at the time of generation of the clearing report.
Card Installments	Number of installments for card payments, if the selected payment method supports installments. Empty for single-charge payments.
Customer Language Id	Language code according to ISO 639-1. This is the language selected by the customer on the checkout page.
Product Id	Unique identifier of the product purchased by the customer.
Product Name	Name of the product purchased by the customer.
Product Group	Group the product is assigned to for reporting purposes. You can create product groups in Commerce Assistant (CA) and use them for quick analysis of sales trends.
Internal Product Id	Internal identifier of the product in your configuration, used for integration and reporting.
Internal Product Name	Internal product name from your configuration, used for integration and reporting.
Reference Bundle Product Id	Unique identifier of the bundle to which the product belongs. A bundle is a combination of two or more products sold together at a specific price.
Reference Bundle Running No	Consecutive number given to each product within a bundle.
Client Id	Unique identifier of your client account, known as client account id.
Internal Product Category	Internal identifier of the categorie of your product.
Internal Product SKU_EAN	Universal Product Code (UPC) or European Article Number (EAN) for boxed products.
Quantity	For purchases, the quantity of items ordered. For reimbursements (follow-up transactions), the value depends on the type of reimbursement: 0 is always given for discounts or coupon codes applied retrospectively; the quantity ordered is given for return debits; the negative quantity ordered is given for all other reimbursements.
Customer Country	Country associated with the customer’s billing profile used for tax, compliance, and reporting (for example, VAT determination).
Customer Vat Percentage	VAT or sales tax percentage applied to the purchase.
Product Currency Id	Currency in which prices are fixed on the purchasing side for further calculations. Corresponds to the Customer Currency if you defined a price for this currency. Otherwise, it corresponds to the base currency for the product.
Billing Company	Company name of the billing contact.
Billing Title	Title of the billing contact.
Billing Salutation Id	Salutation of the billing contact.
Billing First Name	First name of the billing contact.
Billing Last Name	Last name of the billing contact.
Billing City	City of the billing contact.
Billing State	U.S. state or Canadian province of the billing contact.
Billing Country	Country of the billing contact.
Billing Email	Email address of the billing contact.
Billing Phone	Phone number of the billing contact.
Delivery Company	Company name of the delivery contact.
Delivery Title	Title of the delivery contact.
Delivery Salutation Id	Salutation of the delivery contact.
Delivery First Name	First name of the delivery contact.
Delivery Last Name	Last name of the delivery contact.
Delivery City	City of the delivery contact.
Delivery State	U.S. state or Canadian province of the delivery contact.
Delivery Country	Country of the delivery contact.
Delivery Email	Email address of the delivery contact.
Taxation Day	The date that determines when a specific tax rule or tax consequence becomes applicable.
Licensee Company	Company name of the licensee contact.
Licensee Title	Title of the licensee contact.
Licensee Salutation Id	Salutation of the licensee contact.
Licensee First Name	First name of the licensee contact.
Licensee Last Name	Last name of the licensee contact.
Licensee Postal Code	Postal code of the licensee contact.
Licensee City	City of the licensee contact.
Licensee State	U.S. state or Canadian province of the licensee contact.
Licensee Country	Country of the licensee contact.
Licensee Email	Email address of the licensee contact.
Region	Continent of the delivery country.
X-Parameters	All x-parameters for this purchase. The key–value pairs are serialized as strings and separated by a comma. X-parameters are components of URLs used to pass information through the checkout process.
Customer Type	Customer or reseller. Customers buy or subscribe to your products through Cleverbridge. Resellers purchase your products at a discount and then sell the products to their own customers at full price, often through a physical store.
Customer Id	Unique identifier of the customer.
Partner Username	Username of the partner in the Partner Portal. A partner is another business that buys your products in a B2B model.
Partner Company	Name of the partner company.
Promotion Id	Unique identifier of the promotion applied to the purchase.
Promotion Name	Name of the promotion applied to the purchase.
Coupon Code	Coupon code applied to the purchase. A coupon code is a promotional tool that gives customers a specified price discount for a product when the coupon is redeemed.
Cross Subscription Up Selling Id	Unique identifier of the recommendation if the purchased product was a cross-sell, sub-sell, or up-sell. This is the recommendation ID.
Cross Subscription Up Selling Name	Name of the recommendation if the purchased product was a cross-sell, sub-sell, or up-sell.
Product Gross	Undiscounted total gross amount for the line item. In the currency given in Product Currency Id. Relates to the selling side of the transaction.
Product VAT	VAT or sales tax for the undiscounted line item. In the currency given in Product Currency Id. Relates to the selling side of the transaction.
Product Net	Undiscounted total net amount for the line item. In the currency given in Product Currency Id. Relates to the selling side of the transaction.
Product Margin Variable	Percentage resale commission on the line item charged by Cleverbridge. In the currency given in Product Currency Id. Relates to the purchasing side of the transaction.
Product Margin Fix	Fixed resale commission on the line item charged by Cleverbridge. In the currency given in Product Currency Id. Only applies to some purchases, for example, if the cart value is below a defined threshold. Relates to the purchasing side of the transaction.
Product Client Net	Your net revenue on the purchase amount of the line item. In the currency given in Product Currency Id. Relates to the purchasing side of the transaction.
Product Client VAT	VAT or sales tax on the purchase amount of the line item that you must remit to the local tax authorities. In the currency given in Product Currency Id. Relates to the purchasing side of the transaction.
Product Client Gross	Your gross revenue on the purchase amount of the line item. In the currency given in Product Currency Id. Relates to the purchasing side of the transaction.
Exchange Rate	Exchange rate between Product Currency Id and Payout Currency Id.
Payout Currency Id	The payout and clearing currency set for your account in the Cleverbridge platform. This is the currency in which your credit note is generated.
Payout Gross	Discounted total gross amount for the line item. In the currency given in Payout Currency Id. Relates to the selling side of the transaction.
Payout VAT	VAT or sales tax for the discounted line item. In the currency given in Payout Currency Id. Relates to the selling side of the transaction.
Payout Net	Discounted total net amount for the line item. In the currency given in Payout Currency Id. Relates to the selling side of the transaction.
Payout Margin Variable	Percentage resale commission on the line item charged by Cleverbridge. In the currency given in Payout Currency Id. Relates to the purchasing side of the transaction.
Payout Margin Fix	Fixed resale commission on the line item charged by Cleverbridge. In the currency given in Payout Currency Id. Only applies to some purchases, for example, if the cart value is below a defined threshold. Relates to the purchasing side of the transaction.
Payout Client Net	Your net revenue on the purchase amount of the line item. In the currency given in Payout Currency Id. Relates to the purchasing side of the transaction. The sum of these amounts is credited to your accounts for the clearing period. It is given in the credit note that is emailed to you as a PDF file.
Payout Client VAT	VAT or sales tax on the purchase amount of the line item that you must remit to the local tax authorities. In the currency given in Payout Currency Id. Relates to the purchasing side of the transaction.
Payout Client Gross	Your gross revenue on the purchase amount of the line item. In the currency given in Payout Currency Id. Relates to the purchasing side of the transaction.