payouts.list
A shop's payouts to its bank, newest first, so an agent can match each bank deposit.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/payouts |
| MCP tool | payouts_list |
| Writes | no |
| Area | Shop |
When to use it
Doing Work does not connect to QuickBooks itself. Your agent does the sync, on the schedule the shop picks: daily is a good default, and the shop can ask for more or less often.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string | yes |
since | string | no |
limit | integer | no |
cursor | string | no |
Example
GET https://doingwork.work/v1/payouts?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].payout_id | string (uuid) | yes |
data[].processor | string | yes |
data[].processor_ref | string | yes |
data[].status | string | yes |
data[].currency | string | yes |
data[].amount_minor | integer | yes |
data[].speed | string | yes |
data[].fee_minor | integer | yes |
data[].arrival_date | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', ')'] | yes |
data[].paid_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
data[].created_at | string (date-time) | yes |
next_cursor | ['string', 'null'] | yes |
{
"data": [
{
"payout_id": "00000000-0000-4000-8000-000000000000",
"processor": "...",
"processor_ref": "...",
"status": "...",
"currency": "...",
"amount_minor": 50000,
"speed": "...",
"fee_minor": 50000,
"arrival_date": "...",
"paid_at": "...",
"created_at": "..."
}
],
"next_cursor": "..."
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |