Cash Flow reports can be created via API or downloaded from the EasyPost dashboard. Cash Flow sums all spending by an account over each day, separating each fee type and transaction type into columns. If no transactions exist for that day, it is skipped.
What's in the Cash Flow report?
You can access the Cash Flow report in a .csv format through our Reports Object, which you can learn more about here. The .csv file contains the fields listed below with their definitions.
| Field | Definition or Sample Data |
|---|---|
|
bank_account_refund |
Sum of refunded bank account transactions for the day |
|
bank_debits |
Sum of bank debit transactions for the day |
|
carbon_offset_fees |
Sum of purchased carbon offsets for the day |
|
credit_card_debits |
Sum of debited credit card transactions for the day |
|
credit_card_fees |
Sum of incurred credit card fees for the day |
|
credit_card_refund |
Sum of refunded credit card transactions for the day |
|
date |
Transaction date for each transaction included in Cash Flow Report |
|
end_balance |
The available balance at the end of the day |
|
fulfillment_advanced_shipment_notice_fees |
[For previous Fulfillment users] Sum of advanced shipment notice fees for the day |
|
fulfillment_debits |
[For previous Fulfillment users] Sum of manually debited fulfillment fees for the day |
|
fulfillment_fees |
[For previous Fulfillment users] Sum of incurred fulfillment order fees for the day |
|
fulfillment_return_fees |
[For previous Fulfillment users] Sum of incurred fulfillment return fees for the day |
|
insurance_fees |
Sum of incurred insurance fees for the day |
|
invoice_adjustment_fees |
Sum of incurred adjusted invoice fees for the day |
|
label_fees |
Sum of incurred label fees for the day |
|
manual_credits |
Sum of manually credited transactions for the day |
|
manual_debits |
Sum of manually debited transactions for the day |
|
payment_failure_deduction |
Sum of deduction/fee due to payment failure for the day |
|
postage_fees |
Sum of incurred postage fees for the day |
|
refunds |
Sum of refunds applied for the day |
|
start_balance |
The available balance at the beginning of the day |
|
total_fees |
Sum of all fees incurred for the day |
|
tracker_fees |
Sum of incurred tracker fees due to uniquely created tracking information outside EasyPost for the day |
|
utc_offset |
Represents difference in hours and minutes between Coordinated Universal Time (UTC) and local time at a particular place for the day. A negative offset indicates time is west of UTC and a positive offset indicates time is east of UTC. |
|
wire_transfer_debits |
Sum of debited wire transfers for the day |
via EasyPost Dashboard:
Click on your email address to select Billing from dropdown options.
Select date ranges for Cash Flow CSV report to be generated against.
Please note, CSV reports are limited to 31 days at a time.
Scroll down to the "Cash Flow" section and click "Request CSV" to open up the new modal.
Select which columns you want outputted.
By default, fulfillment fields are unselected.
via EasyPost API:
You can create a report, provide a start_date and end_date that are less than 31 days apart. Curl library example is shown below and additional library samples can be found in Docs’ API Reports.
curl -X POST ‘https://api.easypost.com/v2/reports/cash_flow’ \
-u <YOUR PRODUCTION API KEY>: \
-H 'Content-Type: application/json' \
-d '{
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD"
}'
You can also specify "columns" to output the exact columns you need
curl -X POST 'https://api.easypost.com/v2/reports/cash_flow' \
-u <YOUR PRODUCTION API KEY>: \
-d '{"start_date":"2021-06-01","end_date":"2021-06-30",columns":["bank_account_refund","bank_debits","carbon_offset_fees","credit_card_debits","credit_card_fees","credit_card_refund","date","end_balance","fulfillment_advanced_shipment_notice_fees","fulfillment_debits","fulfillment_fees","fulfillment_return_fees","insurance_fees","invoice_adjustment_fees","label_fees","manual_credits","manual_debits","payment_failure_deduction","postage_fees","refunds","start_balance","total_fees","tracker_fees","utc_offset","wire_transfer_debits"]}' \
-H "Content-Type:Application/json"
Comments
0 comments
Article is closed for comments.