PUBLIC API v1
Preview an invoice PDF
GET /api/v1/companies/{company_pk}/invoices/{public_id}/preview/
Return a presigned download URL and a PNG thumbnail of the first page.
Permission: read_invoices · Direct link
Company-scoped. Account permissions, plan limits and document state still apply.
Path and query parameters
| Parameter | Location / type | Description |
|---|---|---|
company_pkRequired | path · string (uuid) | Not specified |
public_idRequired | path · string (uuid) | Not specified |
Responses
200 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
downloadUrlRequired | string (uri) | null | Not specified |
previewImageRequired | string | null | Base64 JPEG thumbnail when available. |
mimeTypeRequired | string | Not specified |
401 The API key is invalid, expired or revoked.
403 Missing scope, company mismatch, unsupported operation, or a plan/account restriction.
429 Rate limit exceeded. Wait for the Retry-After header before retrying.
Use the base URL https://api.norman.finance/api/v1. Sign up or log in to Norman to create an API key, then send it as a Bearer token. For an OpenAPI JSON file, contact support.