sync.changes
Invoices, payments, refunds and customers that changed since a time or cursor, oldest change first, each with its current details and outside ids. Run it on the shop's own schedule and save next_cursor for the next run. With system and unsynced true, only records with no outside id for that system are returned.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/sync/changes |
| MCP tool | sync_changes |
| 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 |
updated_since | string | no |
cursor | string | no |
kinds | array | no |
system | string | no |
unsynced | boolean | no |
limit | integer | no |
Example
GET https://doingwork.work/v1/sync/changes?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].kind | string | yes |
data[].id | string (uuid) | yes |
data[].seq | integer | yes |
data[].changed_at | string (date-time) | yes |
data[].last_event | string | yes |
data[].data | ['object', 'null'] | yes |
data[].external_refs | object | yes |
next_cursor | ['string', 'null'] | yes |
has_more | boolean | yes |
{
"data": [
{
"kind": "...",
"id": "00000000-0000-4000-8000-000000000000",
"seq": 1,
"changed_at": "...",
"last_event": "...",
"data": "...",
"external_refs": {}
}
],
"next_cursor": "...",
"has_more": true
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |