Gallery Platform API
Reference

Regenerate a sale's payables

Re-derives the consignor payables for a sale from its frozen line splits (e.g. after a line's price was edited). Idempotent: still-pending payables are refreshed and any missing ones created; already-paid or voided payables are left untouched.

POST
/gallery/sales/{id}/payables

Re-derives the consignor payables for a sale from its frozen line splits (e.g. after a line's price was edited). Idempotent: still-pending payables are refreshed and any missing ones created; already-paid or voided payables are left untouched.

Authorization

bearerAuth payables:create
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: payables:create

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

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.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "data": [    {      "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",      "created_at": "string",      "updated_at": "string"    }  ]}

Get a sale's cost basis and margin GET

Returns the cost basis and margin of a sale, per line and in total: the consignor and third-party takes (from the payables) plus the gallery's borne production-cost share, subtracted from the sold price. A missing or unauthorized sale is a 404.

List a sale's payables GET

Lists the payables generated from a sale's consigned lines.