Clearing report structure and fields

The clearing report is an Excel spreadsheet that contains several worksheets. The documents available to your account depend on the type of clearing documentation configured for your account. In the sections below, select the tab that correspond to your type of clearing documentation.

• Overview: The Overview sheet gives you a high-level summary of a clearing period and its payout. It shows such details as who you are getting paid as (your client and remittance details), the currency used, and the period start and end. The newer SCM version does not provide sensitive information such as email and phone number, but the content and purpose are the same.

• Details: The Details sheet lists every transaction line included in the clearing period—one row per item or adjustment. It captures the data needed for reconciliation, including key transaction identifiers, commercial values, Cleverbridge fees and margins, and currency details. The SCM version is much more focused with only about 27 focused fields and one payout currency per report. This way the exports are cleaner and reviews are faster, while you can reconcile with the same confidence.

• Other sheets: The other sheets are pivoted summaries of the same underlying data as Details. Each one uses:

  • A grouping column such as Currency, Product, Affiliate, Partner, etc.
  • A Data column that lists metrics such as quantity, purchase type, VAT, fees, and payout totals
  • A Total column with the clearing period sums for the grouping item.

SCM Clearing report fields

Field	Explanation
Client Id	Internal identifier of your Cleverbridge client account. Used to associate the clearing report and payout with your account.
Client Name	Your company’s legal or trading name on file with Cleverbridge. Displayed on clearing documents and used for payout remittance.
Period Start	The start date and time of the clearing period, defining the first moment included in this payout cycle.
Period End	The end date and time of the clearing period, defining the last moment included in this payout cycle.
Company	Beneficiary company name for the payout, as configured in your billing profile.
Firstname	First name of the beneficiary contact for remittance, statements, and finance communications. May be blank if not applicable.
Lastname	Last name of the beneficiary contact for remittance, statements, and finance communications. May be blank if not applicable.
Street 1	Primary street address line for the payout beneficiary’s remittance address.
Street 2	Secondary street address line for the payout beneficiary’s remittance address, used for suite, building, or additional details.
PostalCode	Postal or ZIP code for the remittance address.
City	City for the remittance address.
StateId	State, province, or region identifier for the remittance address. Use the standard code where applicable (for example, “CA” for California).
Country	Country for the remittance address, typically shown as the full country name.

Field	Explanation
Invoice Id	Identifier of the self-billing invoice (credit note) generated for the relevant clearing period. Used to reference the payout document in finance and reconciliation.
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 Date	Date when the self-billing invoice (credit note) was generated for the clearing period.
Product Id	Unique identifier of the product purchased by the customer.
Product Name	Name of the product purchased by the customer.
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).
Product Currency ID	Currency in which prices are fixed on the purchasing side for further calculations. May differ from the currency in which you are paid out. Identical to YourPurchaseCurrencyId.
Product Gross	Undiscounted total gross amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
Product VAT	VAT or sales tax for the undiscounted line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
Product Net	Undiscounted total net amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
Product Margin %	Percentage resale commission on the line item charged by Cleverbridge. In the currency given in YourPurchaseCurrencyId. 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 YourPurchaseCurrencyId. 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 YourPurchaseCurrencyId. 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 YourPurchaseCurrencyId. 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 YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
Exchange Rate	Exchange rate between YourPurchaseCurrencyId and PaymentCurrencyId. If the column shows a currency in parentheses, that is the target currency.
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 PaymentCurrencyId. Relates to the selling side of the transaction.
Payout VAT	VAT or sales tax for the discounted line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Payout Net	Discounted total net amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Payout Margin %	Percentage resale commission on the line item charged by Cleverbridge. In the currency given in PaymentCurrencyId. 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 PaymentCurrencyId. 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 PaymentCurrencyId. 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 PaymentCurrencyId. 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 PaymentCurrencyId. Relates to the purchasing side of the transaction.

• Sample File: Clearing report (SCM)

CA Clearing report fields

Field	Explanation
Client Id	Internal identifier of your Cleverbridge client account. Used to associate the clearing report and payout with your account.
Client Name	Your company’s legal or trading name on file with Cleverbridge. Displayed on clearing documents and used for payout remittance.
Period Start	The start date and time of the clearing period, defining the first moment included in this payout cycle.
Period End	The end date and time of the clearing period, defining the last moment included in this payout cycle.
Company	Beneficiary company name for the payout, as configured in your billing profile.
Firstname	First name of the beneficiary contact for remittance, statements, and finance communications. May be blank if not applicable.
Lastname	Last name of the beneficiary contact for remittance, statements, and finance communications. May be blank if not applicable.
Street 1	Primary street address line for the payout beneficiary’s remittance address.
Street 2	Secondary street address line for the payout beneficiary’s remittance address, used for suite, building, or additional details.
PostalCode	Postal or ZIP code for the remittance address.
City	City for the remittance address.
StateId	State, province, or region identifier for the remittance address. Use the standard code where applicable (for example, “CA” for California).
Country	Country for the remittance address, typically shown as the full country name.
email	Email address for the beneficiary or finance contact. Used for notifications and correspondence about the clearing and payout.
fax	Fax number on file for the beneficiary or finance contact. Rarely used, and often left blank.
BankAccountNo	Domestic bank account number for payouts in markets that require it. For IBAN countries, this may be unused in favor of BankIban.
BankIdentificationCode	National bank identifier used in some countries (for example, routing number, sort code). May be empty if not required for the payout route.
BankName	Name of the beneficiary bank receiving the payout.
BankBic	Bank Identifier Code (BIC/SWIFT) for international routing of the payout.
BankIban	International Bank Account Number (IBAN) of the payout beneficiary’s account. Used where IBAN routing applies.

Field	Explanation
PurchaseId	Unique identifier of the purchase. Called reference number in all communication with customers.
RunningNo	Consecutive number given to each item of a purchase.
ReimbursementId	Unique identifier of a follow-up transaction for a purchase, for example, a refund or retrospective discount.
Purchasestatus	Status of the purchase at the time of generation of the clearing report. For descriptions of the values, see Purchase Status.
PurchasestatusNotificationId	Purchase status code as submitted in the <cbt:StatusId> element of the client notification. For details on what these codes stand for, see Purchase Status.
ReportType	Type of the transaction. This is either a purchase or a reimbursement. A reimbursement is a follow-up transaction for a purchase.
ReportDay	For purchases, the date on which the payment arrived. For reimbursements, the date on which the follow-up transaction occurred.
ReportTime	For purchases, the date and time when the payment arrived. For reimbursements, the date and time when the follow-up transaction occurred.
CreationTime	Date and time when the purchase was created in the Cleverbridge platform. The date corresponds to the purchase date listed in communication with customers.
PaymentArriveTime	Date and time when the payment for a purchase arrived.
ReimbursementTime	Date and time when the follow-up transaction for a purchase occurred.
FulfillmentDate	Date on which the service was provided, for example, delivery of the license key.
CustomerCurrency	Currency in which the customer purchased the product.
Paymenttype	Payment type of the purchase at the time of generation of the clearing report.
CardInstallments	Number of installments for card payments, if the selected payment method supports installments. Empty for single-charge payments.
CustomerLanguageId	Language code according to ISO 639-1. This is the language selected by the customer on the checkout page.
ProductId	Unique identifier of the product purchased by the customer.
ProductName	Name of the product purchased by the customer.
ProductGroup	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.
InternalProductId	Internal identifier of the product in your configuration, used for integration and reporting.
InternalProductName	Internal product name from your configuration, used for integration and reporting.
RefBundleProductId	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.
RefBundleRunningNo	Consecutive number given to each product within a bundle.
InternalProductSKU_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.
CustomerVatPercentage	VAT or sales tax percentage applied to the purchase.
CustomerShippingVatPercentage	If applicable, a different VAT or sales tax percentage for the shipping of a physical product.
VatId	Local VAT or sales-tax ID of a business customer.
CustomerVatType	Country to which VAT or sales tax is remitted.
YourPurchaseCurrencyId	Currency in which prices are fixed on the purchasing side for further calculations. May differ from the currency in which you are paid out. Identical to CurrencyId. Corresponds to the CustomerCurrency if you defined a price for this currency. Otherwise, it corresponds to the base currency for the product.
SubIntervalNo	Running number of every subscription.
SubItemIntervalNo	Running number of every subscription item.
BillingCompany	Company name of the billing contact.
BillingTitle	Title of the billing contact.
BillingSalutationId	Salutation of the billing contact.
BillingFirstname	First name of the billing contact.
BillingLastname	Last name of the billing contact.
BillingStreet1	Street address of the billing contact.
BillingStreet2	Additional street information of the billing contact.
BillingPostalcode	Postal code of the billing contact.
BillingCity	City of the billing contact.
BillingStateId	Code for U.S. state or Canadian province of the billing contact.
BillingState	U.S. state or Canadian province of the billing contact.
BillingCountryId	Country code for the country of the billing contact.
BillingCountry	Country of the billing contact.
BillingEmail	Email address of the billing contact.
BillingPhone1	Phone number of the billing contact.
BillingPhone2	Additional phone number of the billing contact.
BillingFax	Fax number of the billing contact.
DeliveryCompany	Company name of the delivery contact.
DeliveryTitle	Title of the delivery contact.
DeliverySalutationId	Salutation of the delivery contact.
DeliveryFirstname	First name of the delivery contact.
DeliveryLastname	Last name of the delivery contact.
DeliveryStreet1	Street address of the delivery contact.
DeliveryStreet2	Additional street information of the delivery contact.
DeliveryPostalcode	Postal code of the delivery contact.
DeliveryCity	City of the delivery contact.
DeliveryStateId	Code for U.S. state or Canadian province of the delivery contact.
DeliveryState	U.S. state or Canadian province of the delivery contact.
DeliveryCountryId	Country code for the country of the delivery contact.
DeliveryCountry	Country of the delivery contact.
DeliveryEmail	Email address of the delivery contact.
DeliveryPhone1	Phone number of the delivery contact.
DeliveryPhone2	Additional phone number of the delivery contact.
DeliveryFax	Fax number of the delivery contact.
LicenseeCompany	Company name of the licensee contact.
LicenseeTitle	Title of the licensee contact.
LicenseeSalutationId	Salutation of the licensee contact.
LicenseeFirstname	First name of the licensee contact.
LicenseeLastname	Last name of the licensee contact.
LicenseeStreet1	Street address of the licensee contact.
LicenseeStreet2	Additional street information of the licensee contact.
LicenseePostalcode	Postal code of the licensee contact.
LicenseeCity	City of the licensee contact.
LicenseeStateId	Code for U.S. state or Canadian province of the licensee contact.
LicenseeState	U.S. state or Canadian province of the licensee contact.
LicenseeCountryId	Country code for the country of the licensee contact.
LicenseeCountry	Country of the licensee contact.
LicenseeEmail	Email address of the licensee contact.
LicenseePhone1	Phone number of the licensee contact.
LicenseePhone2	Additional phone number of the licensee contact.
LicenseeFax	Fax number of the licensee contact.
LicenseeString	Name of the licensee as a string. Depending on whether the licensee is a natural person or a business, the full name or company name is used.
Digital or Physical	Whether the product is set up as digital or physical.
Region	Continent of the delivery country.
ShipperService	If applicable, the courier service that delivered the physical product.
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.
AffiliateId	Unique identifier of the affiliate that generated the sale.
AffiliateName	Name of the affiliate that generated the sale.
X-Affiliate	All x-parameters with the key x-affiliate. In affiliate management, x-parameters are used for revenue tracking.
CustomerType	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.
CustomerId	Unique identifier of the customer.
PartnerUserName	Username of the partner in the Partner Portal. A partner is another business that buys your products in a B2B model.
PartnerCompany	Name of the partner company.
PromotionId	Unique identifier of the promotion applied to the purchase.
PromotionName	Name of the promotion applied to the purchase.
Couponcode	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.
CrossSubUpSellingId	Unique identifier of the recommendation if the purchased product was a cross-sell, sub-sell, or up-sell. This is the recommendation ID.
CrossSubUpSellingName	Name of the recommendation if the purchased product was a cross-sell, sub-sell, or up-sell.
CurrencyId	Currency in which prices are fixed on the purchasing side for further calculations. May differ from the currency in which you are paid out. Identical to YourPurchaseCurrencyId.
ProductGrossRevenue	Undiscounted total gross amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
ProductCollectedVat	VAT or sales tax for the undiscounted line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
ProductNetRevenue	Undiscounted total net amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
DiscountGrossRevenue	Discount on the total gross amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
DiscountCollectedVat	VAT or sales-tax portion of the discount on the total gross amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
DiscountNetRevenue	Discount on the total net amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
ShippingGrossRevenue	Gross shipping costs for a physical product. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
ShippingCollectedVat	VAT or sales-tax portion of gross shipping costs for a physical product. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
ShippingNetRevenue	Net shipping costs for a physical product. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
GrossRevenue	Discounted total gross amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
CollectedVat	VAT or sales tax for the discounted line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
NetRevenue	Discounted total net amount for the line item. In the currency given in YourPurchaseCurrencyId. Relates to the selling side of the transaction.
CbMarginPercentage	Percentage resale commission on the line item charged by Cleverbridge. In the currency given in YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
CbMarginFix	Fixed resale commission on the line item charged by Cleverbridge. In the currency given in YourPurchaseCurrencyId. Only applies to some purchases, for example, if the cart value is below a defined threshold. Relates to the purchasing side of the transaction.
CbMarketingFee	Commission on the line item charged by Cleverbridge if the sale was generated by an affiliate. In the currency given in YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
AffiliateCommission	Commission on the line item passed to the affiliate that generated the sale. In the currency given in YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
CbShippingFee	Commission on the line item charged by Cleverbridge if the product was physically shipped. In the currency given in YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
YourNetProfit	Your net revenue on the purchase amount of the line item. In the currency given in YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
YourVat	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 YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
YourGrossProfit	Your gross revenue on the purchase amount of the line item. In the currency given in YourPurchaseCurrencyId. Relates to the purchasing side of the transaction.
Exchange Rate (USD)	Exchange rate between currency given in YourPurchaseCurrencyId and currency given in PaymentCurrencyId. This column shows the rate for the currency indicated in parentheses.
PaymentCurrencyId	The payout and clearing currency set for your account in the Cleverbridge platform. This is the currency in which your credit note is generated.
Product Gross (Customer to CB)	Undiscounted total gross amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Product VAT (Customer to CB)	VAT or sales tax for the undiscounted line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Product Net (Customer to CB)	Undiscounted total net amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Discount Gross (Customer to CB)	Discount on the total gross amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Discount VAT (Customer to CB)	VAT or sales-tax portion of the discount on the total gross amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Discount Net (Customer to CB)	Discount on the total net amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Shipping Gross (Customer to CB)	Gross shipping costs for a physical product. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Shipping VAT (Customer to CB)	VAT or sales-tax portion of the gross shipping costs for a physical product. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Shipping Net (Customer to CB)	Net shipping costs for a physical product. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Gross (Customer to CB)	Discounted total gross amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
VAT (Customer to CB)	VAT or sales tax for the discounted line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
Net (Customer to CB)	Discounted total net amount for the line item. In the currency given in PaymentCurrencyId. Relates to the selling side of the transaction.
CB %	Percentage resale commission on the line item charged by Cleverbridge. In the currency given in PaymentCurrencyId. Relates to the purchasing side of the transaction.
CB fix	Fixed resale commission on the line item charged by Cleverbridge. In the currency given in PaymentCurrencyId. Only applies to some purchases, for example, if the cart value is below a defined threshold. Relates to the purchasing side of the transaction.
Affiliate Commission	Commission on the line item passed to the affiliate that generated the sale. In the currency given in PaymentCurrencyId. Relates to the purchasing side of the transaction.
Marketing Fee	Commission on the line item charged by Cleverbridge if the sale was generated by an affiliate. In the currency given in PaymentCurrencyId. Relates to the purchasing side of the transaction.
Shipping	Commission on the line item charged by Cleverbridge if the product was physically shipped. In the currency given in PaymentCurrencyId. Relates to the purchasing side of the transaction.
Net (CB to Client)	Your net revenue on the purchase amount of the line item. In the currency given in PaymentCurrencyId. 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.
VAT (CB to Client)	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 PaymentCurrencyId. Relates to the purchasing side of the transaction.
Gross (CB to Client)	Your gross revenue on the purchase amount of the line item. In the currency given in PaymentCurrencyId. Relates to the purchasing side of the transaction.

• Sample File: Clearing report (CA)

Did you find this doc useful?