Confirm a payable's review
Clears `needs_review` on a payable, so it can be settled or paid out. A flat-net consignor payable on a $0 sale is generated flagged. Only a signed-in gallery owner, or an owner or admin of the gallery's organization, may call it; API keys, app and device credentials and other members answer 403, in a dry run too. A payable that needs no review answers 409 `conflict` with `details.reason` `payable_review_not_needed`. Regenerating the sale's payables keeps the flag clear while the payable's amount stays the confirmed one.
Clears needs_review on a payable, so it can be settled or paid out. A flat-net consignor payable on a $0 sale is generated flagged. Only a signed-in gallery owner, or an owner or admin of the gallery's organization, may call it; API keys, app and device credentials and other members answer 403, in a dry run too. A payable that needs no review answers 409 conflict with details.reason payable_review_not_needed. Regenerating the sale's payables keeps the flag clear while the payable's amount stays the confirmed one.
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.
Confirm a payable flagged needs_review, so it can be settled or paid out.
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", "needs_review": true, "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}Update a party PATCH
Updates a party's base fields and its sub-profiles. For a member, edits accumulate in the working draft until the next save; for an API key or an installed app, they land on the record. Pass `draft` to choose; `applied_to` in the response says where the write went.
Get a payable GET
Returns one consignor payable: the owed amount and currency, the payee, the sale and line it arose from, the frozen basis, and its settlement status.