since 1999

Home / Documentation / API / Invoices

API reference · 18.08.2026

Invoices

The signed-in bidder's invoices: list, retrieve, download the PDF, raise an invoice for a cost, set a shipping preference.

GET /v1/me/invoices/{id}

Returns one of the caller's own invoices.

Api-Key headermember token

Signed-in member. Send the token from POST /v1/sessions. Always send Api-Key as well.

Parameters

NameInTypeRequired
id
Invoice id.
pathinteger (int32)yes

Responses

StatusMeaningBody
200OK
GET /v1/me/invoices

The caller's own invoices.

Api-Key headermember token

Returns the signed-in member's invoices, newest first, in the standard paged envelope: Items, TotalCount, Page, PageSize, TotalPages.

Narrow the list with auctionId or paymentStatus. Omit pageSize forthe tenant's default; it is capped regardless of what you ask for. The member is taken from your token, so there is no member parameter and no way to readanybody else's invoices. For one invoice with its lines useGET /v1/me/invoices/{id}, and for the PDF GET /v1/me/invoices/{id}/pdf.

Parameters

NameInTypeRequired
pagequeryinteger (int32)no
pageSizequeryinteger (int32)no
auctionIdqueryinteger (int32)no
paymentStatusquerystringno

Responses

StatusMeaningBody
200OK
POST /v1/me/invoices

Raises an invoice for a cost, such as shipping, against the caller.

Api-Key headermember token

The invoice is raised against the token holder; the body cannot name a member.

Request body · application/json · AddInvoiceByCostRequest

PropertyTypeRequired
PaymentStatusinteger (int32)no
LanguageCodestringno
ExtraCostListarray of ExtraCostListno
AuctionIdinteger (int32)no

ExtraCostList

PropertyTypeRequired
ExtraCostIdinteger (int32)no

Responses

StatusMeaningBody
200OK
GET /v1/me/invoices/{id}/pdf

Downloads one of the caller's own invoices as a PDF.

Api-Key headermember token

Signed-in member. Send the token from POST /v1/sessions. Always send Api-Key as well.

Parameters

NameInTypeRequired
id
Invoice id.
pathinteger (int32)yes

Responses

StatusMeaningBody
200OK
PUT /v1/me/invoices/{id}/shipping

Chooses collection or delivery for one of the caller's invoices.

Api-Key headermember token

Records how the buyer wants their lots: ShippingStatus: true for delivery, false for collection in person. That is the whole body — the invoice comes from the URL and the member from your token.

Choosing delivery does not price it. Shipping is added to the invoice separately, so thetotal may change after this call; re-read the invoice to show the buyer what they owe. Returns the updated invoice.

Parameters

NameInTypeRequired
id
The invoice, which must belong to the signed-in member.
pathinteger (int32)yes

Request body · application/json · ShippingStatusRequest

PropertyTypeRequired
ShippingStatusbooleanno

Responses

StatusMeaningBody
200OK