Distributions Columns Available to Export
Violet allows you to export financial transactions, from the point of order through payment processing, to eventual payout, with a detailed breakdown of fees, commissions, and other financial metrics related to orders and their components. This page provides details on the columns you are able to export.
The Distributions section outlines the specifics of the split of payments, including refunds, for a given bag in an order. This is the most granular level of financial data available to you, since you’re able to see how much commission was received by a specific merchant in a single order. Each record has a unique ID, a creation date, an amount that could be positive (for payments) or negative (for refunds), the currency used, and the type of transaction.
Payment Gateway details involve the mechanics behind processing payments through our payments provider, Stripe. It includes the service name, total fees (which are a sum of fixed and volume-based fees), and an external transaction ID for tracking purposes.
Payouts are the top level funds receieved in your bank account via Stripe, for a collection of Orders. Key information such as the payout ID, date, and amount are initially null until the transfer initiates. It also specifies whether the payout is for a merchant or a channel.
Order and Bags sections are about the sales transactions. Orders are identified by an ID and have a total value, which gets replicated in associated distributions for multi-bag orders. Bags carry detailed information about the sale, including ID, merchant details, commission rates, totals for various calculations (subtotals, taxes, shipping, discounts), and a refund ID if applicable.
Distributions
| Field Name | Export Name | API Name | Definition |
|---|---|---|---|
| Distribution ID | distribution_id | id | The id of the Distribution record |
| Distribution Date Created | distribution_date_created | date_created | The date the Distribution record was created |
| Distribution Amount | distribution_amount | amount | The amount of the Distribution. Can be positive or negative based on type. |
| Distribution Currency | distribution_currency | currency | The currency of the Distribution. |
| Distribution Type | distribution_type | type | The type of the Distribution. Can be of type PAYMENT or REFUND |
Payment Gateway
| Field Name | Export Name | API Name | Definition |
|---|---|---|---|
| Payment Service | payment_service | payment_service | The payment gateway provider (e.g. Stripe, Cordova…) |
| Payment Service Total Fee | payment_service_total_fee | payment_service_total_fee | The total fee is equal to the fixed fee plus the volume fee |
| Payment Service Fixed Fee | payment_service_fixed_fee | payment_service_fixed_fee | The fixed fee of the charge. Depends on the gateway fee and number of bags in an order. (e.g. Stripe fixed fee on single bag order is $0.30) |
| Payment Service Volume Fee | payment_service_volume_fee | payment_service_volume_fee | The volume fee of the charge. Depends on the gateway percentage taken and total cost of the bag. (e.g. Stripe volume fee on a 0.29) |
| External Transaction ID | payment_service_external_transaction_id | external_transaction_id | The id of the charge in the external payment gateway |
Payouts
A payout is generated when money begins to transfer to your bank account. Before that happens the id, date, and amount fields on a distribution record will be null.
| Field Name | Export Name | API Name | Definition |
|---|---|---|---|
| Payout ID | payout_id | payout_id | The ID of the Payout that the distribution is associated with. |
| Payout Date | payout_date | payout_date | The date the Payout was created. |
| Payout Amount | payout_amount | payout_amount | The amount of the payout. This is the amount that will be seen transferred into your bank account. In the export, this amount will be duplicated on each associated distribution. |
| Payout Account Type | payout_account_type | payout_account_type | This determines whether the Payout was to a merchant or a channel. |
Order
| Field Name | Export Name | API Name | Definition |
|---|---|---|---|
| Order ID | order_id | order_id | The ID of the Order that the distribution is associated with. |
| Order Total | order_total | order_total | The total of the Order. In multi-bag orders, this amount will be duplicated on each associated distribution. |
Bags
| Field Name | Export Name | API Name | Definition |
|---|---|---|---|
| Bag ID | bag_id | bag_id | The ID of the Bag the distribution is associated with. |
| Merchant ID | bag_merchant_id | merchant_id | The ID of the Merchant on the Bag |
| Merchant Name | bag_merchant_name | merchant_name | The name of the Merchant |
| Merchant Commission Rate | bag_merchant_commission_rate | merchant_commission_rate | The commission rate the Channel will receive from the Merchant sale |
| Bag Total | bag_total | bag_total | The total of the Bag |
| Bag Sub Total | bag_subtotal | bag_sub_total | The subtotal of the Bag before tax, shipping, and discounts |
| Bag Tax Total | bag_tax_total | bag_tax_total | The tax of the Bag. Tax is calculated after discounts, before shipping. |
| Bag Shipping Total | bag_shipping_total | bag_shipping_total | The shipping total of the Bag. |
| Bag Discount Total | bag_discount_total | bag_discount_total | The discount amount of the Bag, comes from the subtotal. (e.g. 10% off 5.00) in this field. |
| Refund ID | refund_id | refund_id | If the distribution is a refund, this is the ID that can be used to get refund data from the API |