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.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/books/exports |
| MCP tool | books_exports |
| Writes | no |
| Area | Shop |
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.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
limit | integer | no |
Example
GET https://doingwork.work/v1/books/exports?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].export_id | string (uuid) | yes |
data[].period_start | string | yes |
data[].period_end | string | yes |
data[].include_imported | boolean | yes |
data[].ledger_rows | integer | yes |
data[].invoice_files | integer | yes |
data[].payment_files | integer | yes |
data[].sha256 | string | yes |
data[].created_by | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
data[].created_at | string (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
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |