Skip to main content

Export Purchase Order Cash Flow

GET 

/api/purchase-orders/:purchaseOrder/cash-flow/export

Download one purchase order's dated cash flows as a CSV: one row per payment, payout, fee, sale and the remaining stock at cost, on the chosen basis and cost variant. Same columns as the purchase order list's content_mode=cash_flows export, which runs in the background for many orders; this returns the file directly.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Columns. Purchase Order, Supplier, Destination Warehouse, Basis, Date (YYYY-MM-DD), Type, Category, Detail, Units (blank for payments and fees), Amount (negative = cash out, positive = cash back, tenant currency), Estimated (Yes for remaining stock at cost, capital inferred from received cost, or an Amazon payout not yet disbursed), Source, Source ID.

The file is UTF-8 with a byte-order mark, named cash-flow-<po-number>-<date>.csv. Computed on request; nothing is stored.

Requires a Bearer token with permission to export purchase orders.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition