books.exports

Owner or office: the shop's past books exports, newest first: period, row counts and sha256 (to check a file you were sent). Run books.export again to get a new download link.

WhoAgents can call this
RESTGET /v1/books/exports
MCP toolbooks_exports
Writesno
AreaShop

When to use it

If your agent syncs QuickBooks, use the sync above; it keeps every invoice, payment and fee matched. books.export is the fallback for a bookkeeper or for a shop that imports by hand: pick a month (or from and to) and you get one ZIP with a ledger CSV of every invoice, void, payment, refund, fee and payout, QuickBooks Online invoice import files and QuickBooks Online bank upload files for a clearing account, plus a README that says how to import each one.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstring (uuid)yes
limitintegerno

Example

GET https://doingwork.work/v1/books/exports?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
dataarrayyes
data[].export_idstring (uuid)yes
data[].period_startstringyes
data[].period_endstringyes
data[].include_importedbooleanyes
data[].ledger_rowsintegeryes
data[].invoice_filesintegeryes
data[].payment_filesintegeryes
data[].sha256stringyes
data[].created_by['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
data[].created_atstring (date-time)yes
{
  "data": [
    {
      "export_id": "00000000-0000-4000-8000-000000000000",
      "period_start": "...",
      "period_end": "...",
      "include_imported": true,
      "ledger_rows": 1,
      "invoice_files": 1,
      "payment_files": 1,
      "sha256": "...",
      "created_by": "00000000-0000-4000-8000-000000000000",
      "created_at": "..."
    }
  ]
}

Errors

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