Private preview of the new site. Not live.

payouts.get

One payout broken down: each payment and refund in it, the processor fee and the Doing Work fee on each, and the net. The items add up to the payout amount.

WhoAgents can call this
RESTGET /v1/payouts/get
MCP toolpayouts_get
Writesno
AreaShop

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.

Input

FieldTypeRequired
payout_idstringyes

Example

GET https://doingwork.work/v1/payouts/get?payout_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
payout_idstring (uuid)yes
processorstringyes
processor_refstringyes
statusstringyes
currencystringyes
amount_minorintegeryes
speedstringyes
fee_minorintegeryes
arrival_date['string', 'null', ' ', '(', 'd', 'a', 't', 'e', ')']yes
paid_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
created_atstring (date-time)yes
itemsarrayyes
items[].kindstringyes
items[].processor_refstringyes
items[].description['string', 'null']yes
items[].charge_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].refund_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].invoice_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].amount_minorintegeryes
items[].processor_fee_minorintegeryes
items[].platform_fee_minorintegeryes
items[].net_minorintegeryes
totalsobjectyes
totals.amount_minorintegeryes
totals.processor_fee_minorintegeryes
totals.platform_fee_minorintegeryes
totals.net_minorintegeryes
{
  "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": "...",
  "items": [
    {
      "kind": "...",
      "processor_ref": "...",
      "description": "40 gallon gas heater, installed",
      "charge_id": "00000000-0000-4000-8000-000000000000",
      "refund_id": "00000000-0000-4000-8000-000000000000",
      "invoice_id": "00000000-0000-4000-8000-000000000000",
      "amount_minor": 50000,
      "processor_fee_minor": 50000,
      "platform_fee_minor": 50000,
      "net_minor": 50000
    }
  ],
  "totals": {
    "amount_minor": 50000,
    "processor_fee_minor": 50000,
    "platform_fee_minor": 50000,
    "net_minor": 50000
  }
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.