List Cash Disbursements
GET https://api.suger.cloud/ai/org/{orgId}/revenue/cash-disbursement
Returns this organization's cash disbursement rows as a page, with the total count and a summary alongside them. A row is the cash expected and received for a revenue record, a payment transaction or an AWS billing event, and carries its partner, status, currency, expectedAmount, expectedDate, receivedAmount, receivedDate, reference and linked invoices. The summary gives received and outstanding totals, the number of rows with issues, and totals per partner. `partner`, `status`, `currency`, `buyerId`, `entitlementId`, `recordId` and the date range `startDate` to `endDate` narrow the rows, and `limit` and `offset` page through them.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
limit | query | string | no | Rows per page. The default is 20 and the maximum is 500. |
offset | query | string | no | Number of rows to skip. The default is 0. |
search | query | string | no | Text matched, ignoring case, against the row fields and the buyer name. |
recordId | query | string | no | Only rows for this revenue record id. |
entitlementId | query | string | no | Only rows for this entitlement id. |
buyerId | query | string | no | Only rows for this buyer id. |
partner | query | string | no | Only rows from this partner, for example AWS, AZURE, GCP or STRIPE. |
status | query | string | no | Cash status, for example RECEIVED, AWAITING_PAYOUT, PENDING, OVERDUE, ESTIMATED, NO_CASH_OFFSET or FAILED. |
currency | query | string | no | Three-letter currency code. Only rows in this currency, and a summary for it. |
startDate | query | string | no | First day to include, as YYYY-MM-DD or an ISO 8601 timestamp. |
endDate | query | string | no | Last day to include, as YYYY-MM-DD (the whole day, UTC) or an ISO 8601 timestamp. |
sortBy | query | string | no | One of disbursedDate, expectedAmount or receivedAmount. The default is the received date. |
sortOrder | query | string | no | asc or desc. The default is desc. |
Responses
200 — Cash disbursements
Content-Type: application/json
Response fields:
| Field | Type | Required | Description |
|---|---|---|---|
rows | array<object> | yes | |
total | number | yes | |
limit | number | yes | |
offset | number | yes |
400 — Invalid cash query
Content-Type: application/json
Response fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | |
detail | string | no |
403 — Missing Revenue permission
Content-Type: application/json
Response fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | |
detail | string | no |
413 — Request body too large
Content-Type: application/json · Schema: RevenuePayloadTooLargeResponse
RevenuePayloadTooLargeResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | object | yes |
500 — Cash query failed
Content-Type: application/json
Response fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | |
detail | string | no |
Example
Generated from this operation's schema. Values are placeholders —
substitute your own ids, and set SUGER_TOKEN to a bearer token
from the OAuth client-credentials exchange.
Request
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/revenue/cash-disbursement' \
-H "Authorization: Bearer $SUGER_TOKEN" Response — 200
{
"rows": [
{
"partner": "string"
}
],
"total": 100,
"limit": 100,
"offset": 100
} Error — 400
{
"error": "string",
"detail": "string"
} View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.