Money
List cash-on-delivery balances
Per courier, like Your cash on the Overview: what it owes for delivered orders it hasn't paid for yet (outstanding), and what its payouts brought against what they were expected to (paid). courier null is orders delivered without a courier.
Returns
200 OK · The balances. CodBalanceList
- objectstringRequired
always "list"
- has_morebooleanRequired
- next_cursorstring or nullRequired
Pass as
cursorto get the next page.nullon the last page. - dataarray of objectsRequired
4 child fields
- objectstring
always "cod_balance"
- courierstring or null
- outstandingobject
2 child fields
- orders_countinteger
- amountMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- paidobject
4 child fields
- payouts_countinteger
- receivedMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- expectedMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- differenceMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
Errors
Every error has the same shape. This endpoint can answer with:
