Invoices: Retrieves the metadata of an invoice's PDF document.
GET
/api/invoicing/invoices/{id}/pdf/metadata
deprecated
Requires: Invoicing.Invoices, merchant scope.
Returns the stored blob name, the suggested download file name, and the document size without transferring the document. Rendering and caching happen on the same cache-first terms as the download endpoint.
Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id
required |
path | string (uuid) | The invoice identifier. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 The PDF document metadata.
Body: InvoicePdfResultDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
invoiceId
required |
string (uuid) | The invoice ID this PDF belongs to. |
blobName
required |
string | The blob storage name where the PDF is stored. nullable |
fileName
required |
string | Suggested filename for download (e.g., "INV-2024-0001.pdf"). nullable |
sizeBytes
required |
integer (int64) | Size of the PDF in bytes. |
This response has no documented body fields.
403 The caller does not hold the invoice read permission, or invoicing is not enabled for the account (`Invoicing:Feature:NotEnabled`).
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
404 The invoice does not exist or the caller cannot see it (`Invoicing:Invoice:NotFound`), or it belongs to another biller (`Invoicing:Biller:ForeignBillerNotAllowed`).
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
400 Bad Request
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.