Skip to main content

List Drop-ship Order Money

GET 
/api/reports/dropship-order-money

Paginated Drop-ship Order Money report — one row per drop-ship purchase order (a purchase order linked to a sales order), pairing the money owed on both sides of the same trade.

Required scope: reports:read

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

Each row carries the customer side (what the sales order was billed, what has been received against it, and the balance still due) and the supplier side (the purchase order total, the vendor deposits actually paid, and the balance still owed). customer_settled is true once receipts cover the billed amount — for businesses that release goods from the factory only after the customer's balance lands, that is the column to watch.

Only vendor deposits in a committed state (paid, partially paid, partially applied, fully applied) count toward supplier_paid; drafts and deposits awaiting approval are intent, not spend, and are excluded so the paid figure cannot overstate what has left the bank. All money is expressed in the tenant's base currency.

Filters: filter[search], filter[supplier_id], filter[customer_id] inline; everything else through the filter_groups advanced tree (see the parameter description).

Sorting (sort): prefix with - for DESC. Allowed: purchase_order_number, purchase_order_date, order_status, id. Default: -purchase_order_date.

Pagination: page (default 1), per_page (default 10).

The money columns (billed, received, customer due, PO total, deposits paid, supplier due) are computed per row from the underlying orders and deposits — they are returned on every row but are deliberately NOT filterable or sortable, because they are not database columns.

Request​

Responses​

OK

Response Headers
    Content-Type