Invoices: Retrieves the metadata of an invoice's PDF document.
GET
/api/invoicing/invoices/{invoiceId}/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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
invoiceId
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.
| Field | Type | Description |
|---|
This response has no documented body fields.
403 The caller's biller scope does not cover this invoice.
| Field | Type | Description |
|---|
This response has no documented body fields.
404 No invoice exists with the specified id.
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
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.
| Field | Type | Description |
|---|
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.