sync.setRef

Record the id an outside system (like quickbooks) uses for an invoice, payment, refund or customer, so your sync can update it instead of making a duplicate. Send external_id null to clear it. Owner or office, or their agent.

WhoAgents can call this
RESTPOST /v1/sync/refs
MCP toolsync_setRef
Writesyes, send an Idempotency-Key
AreaShop

When to use it

Record the id an outside system (like quickbooks) uses for an invoice, payment, refund or customer, so your sync can update it instead of making a duplicate. Send external_id null to clear it.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
shop_idstring (uuid)yes
kindstring (one of invoice, payment, refund, customer)yes
idstring (uuid)yes
systemstringyes
external_id['string', 'null']yes

Example

POST https://doingwork.work/v1/sync/refs
content-type: application/json
Idempotency-Key: 3f1c...

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "kind": "invoice",
  "id": "00000000-0000-4000-8000-000000000000",
  "system": "...",
  "external_id": "00000000-0000-4000-8000-000000000000"
}

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

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