The CSV files downloaded on your dashboard lets you reconcile charges and any refunds with your users' accounts.
This page describes the format of the CSV file downloaded through the Billing screen on the Sendle Dashboard. This is not relevant if you access the offline billing CSV files we provide via SFTP – those files are documented here.
Amounts can be calculated using the Price
and Currency
fields. Note that while refunds show as their own row, they show the original order price and not a negative amount. The Refund Date
contains information on when the refund was actually applied to the order.
Charge Type | Type Field | Paid Field | Notes |
---|---|---|---|
Order Costs | Order Invoiced | paid | |
Under-declared Adjustment or Oversized Adjustment | Adjustment: Incorrect size declared | paid | Adjustment fee for orders over the declared or the max allowed size. |
Under-declared Adjustment Refund | Size adjustment charge refunded | refunded | |
Package type adjustment | Adjustment: Package Type | paid | Adjustment charge if carrier-branded packaging is used and that results in extra carrier charges. For more information see this help centre article. |
Package type adjustment refund | Package type adjustment refunded | refunded | |
Cancellation Refund | Order Invoiced | refunded | Absent if cancelled in the same invoice cycle. |
Other Refund | Order Invoiced | refunded | Delay, loss, damage, etc. |
Un-cancellation | Order Invoiced | paid | Appears as a standard order. |
Oversize Penalty | Adjustment: Oversize penalty | paid | Additional penalty charge for an order which exceeds the allowed size for the route. |
If you are offering Sendle Extra Cover, note that Warranty Price
is included in the Price
field and should not be added as a secondary charge.
Details for Under-Declared and Oversize
This CSV file includes information about the cause of Under-Declared or Oversize charges. This can be helpful with explaining the adjustment to a customer. Specifically:
- The declared size, provided to Sendle:
Declared Max Weight
,Declared Max Volume
- The actual
Measured Weight
,Measured Volume
,Measured Length
,Measured Width
,Measured Height
- All units are provided as
Weight Unit
,Volume Unit
andDimensional Unit
Setup
- Go to the Billing screen on your dashboard.
- View an invoice and click "Download (.csv)"
Dashboard Billing CSV Format
The dashboard billing CSV file differs based on the currency used (due to taxes, regional naming differences, etc). The AUD
/CAD
/USD
columns note which fields are returned in which currencies.
Field | AUD | CAD | USD | Example | Notes |
---|---|---|---|---|---|
Account Name | - | - | - | sendleCatSocksID | The Sendle account associated with this order. |
Type | - | - | - | See notes | Note that it is possible to have an Order, Adjustment, Refund and Adjustment Refund in the same invoice for the same Sendle Reference. Valid values: - Order - Refund - Adjustment: Incorrect size declared - Adjustment: Package Type - Size adjustment charge refunded - Package type adjustment charge refunded |
Account Email | - | - | - | [email protected] | The email of the Sendle account associated with this order. |
Sendle Reference | - | - | - | SYF2W2A | 6-8 characters, starting with S. |
Label Number | - | - | - | AUSUAH86F9Y8EE | The internal label number of this order. |
Date Created | - | - | - | 2019 Dec 05 12:57:48 | Date and time the event occurred (UTC). |
Pickup Date | - | - | - | 2019 Dec 06 | Only present for Pick Up orders (local time). |
- | AUD | CAD | USD | - | - |
Receiver Name | - | - | - | Leona White | |
Receiver Email | - | - | - | [email protected] | |
Receiver Suburb | Receiver City | Receiver City | Bacchus Marsh | ||
Receiver Postcode | Receiver Postcode | Receiver ZIP Code | 3340 | ||
Receiver State | Receiver Province | Receiver State | Alberta | ||
Receiver Country | - | - | - | Australia | |
Sender Name | - | - | - | Cat Socks | |
Sender Email | - | - | - | [email protected] | |
Sender Suburb | Sender City | Sender City | Glebe | ||
Sender Postcode | Sender Postcode | Sender ZIP Code | 2037 | ||
Sender State | Sender Province | Sender State | Alberta | ||
Sender Country | - | - | - | Australia | |
Description | - | - | - | CS-643678 | |
Customer Reference | - | - | - | Cat Socks | |
- | AUD | CAD | USD | - | - |
Declared Max Weight | - | - | - | 0.5 | |
Declared Max Volume | - | - | - | 2 | |
Measured Weight | - | - | - | 2.5 | Only present on Adjustment rows. |
Measured Volume | - | - | - | 3 | Only present on Adjustment rows. |
Measured Length | - | - | - | 12 | Only present on Adjustment rows. |
Measured Width | - | - | - | 12 | Only present on Adjustment rows. |
Measured Height | - | - | - | 18 | Only present on Adjustment rows. |
Weight Unit | - | - | - | KG | Configured for your account. Typically KG or LB. |
Volume Unit | - | - | - | L | Configured for your account. Typically L or IN3. |
Dimensional Unit | - | - | - | CM | Configured for your account. Typically CM, M or IN. |
- | AUD | CAD | USD | - | - |
Total Price | - | - | - | 14.00 | Price of the order including taxes and the cost for extra cover. Positive for charges (order, adjustment), negative for refunds. |
Delivery Charge (excl tax) | Delivery Charge (excl tax) | 12.05 | The base price for this route, excluding tax. | ||
Delivery | 12.05 | The base price for this route. | |||
Service | 0.05 | Any service charge that is applied. | |||
Fuel Surcharge (excl tax) | Fuel Surcharge (excl tax) | 0.15 | Any fuel surcharge that is applied, excluding tax. | ||
Fuel Surcharge | 0.15 | Any fuel surcharge that is applied. | |||
Extra Cover Charge (excl tax) | 0.15 | Any extra cover charge that is applied, excluding tax. | |||
GST | GST | 1.27 | Australian GST or Canadian GST | ||
HST | 0.58 | Canadian Harmonized Sales Tax | |||
QST | 0.58 | Québec Sales Tax | |||
Currency | - | - | - | AUD | |
Paid | - | - | - | The payment state of this order. | |
Invoice Number | - | - | - | SEN41876-1949 | The invoice for the original charge. - On an Order or Adjustment, this is the invoice it was charged in. - On a refund, this is the original invoice of the charge being refunded. |
Refund Date | - | - | - | Only present if order was refunded | |
Requested Cover | The dollar amount for any additional or included cover, if applicable. | ||||
Paid By | - | - | - | Only present if any of the orders in this invoice were paid for by another Sendle account. Valid values: - This Account - Third Party |
You'll get a column added to the end for each metadata key on orders. For example, creating an order with the metadata {"order_id": "126"}
will mean you get a column named order_id
on the CSV file.
If one of your metadata values is an object, it'll be represented in a very strange way in the CSV. For example, if you pass in "metadata": {"your_data": {"nested": "12345678"}}
, in the output CSV file you'll get a column with the data "{""nested""=>""12345678""}"
. Because of this, we recommend only using simple data types in metadata keys if you want to read them from the CSV file.
If you have a metadata key with the same name as one of the above columns, you'll get two columns with that name (first, the original one that we provide, and then the metadata one).
Avoid using the above field names inside order metadata to prevent this confusion.