Settle a payable
Marks a pending payable `paid`: the gallery has paid the payee. It records the payment and moves no money; the payout route transfers funds. The paid amount defaults to the owed amount and the paid time to now. A paid or void payable answers 409.
Marks a pending payable paid: the gallery has paid the payee. It records the payment and moves no money; the payout route transfers funds. The paid amount defaults to the owed amount and the paid time to now. A paid or void payable answers 409.
Authorization
bearerAuth payables:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: payables:update
Path Parameters
The payable id.
Query Parameters
Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.
Header Parameters
Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Mark a pending payable paid.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "sale_id": "string", "sale_item_id": "string", "artwork_id": "string", "payee_contact_id": "string", "payee_name": "string", "kind": "consignor", "status": "pending", "amount_cents": -9007199254740991, "currency": "string", "basis_bps": 0, "basis_amount_cents": -9007199254740991, "paid_amount_cents": -9007199254740991, "paid_at": "string", "notes": "string", "metadata": { "property1": "string", "property2": "string" }, "created_at": "string", "updated_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}Batch-settle payables POST
Marks many pending payables paid at once (each settled at its owed amount). Idempotent: already-paid or voided payables, and any not in this gallery, are skipped. Returns the payables actually settled.
Get an artist/consignor statement GET
Returns everything the gallery owes one payee — line detail plus per-currency totals net of the consignor's reimbursable (consignor_100) production costs.