Download an invoice PDF#

The invoice as a GST-format PDF, group-scoped exactly like GET /v1/invoices/{id}.

A PDF that was never stored is rendered on demand rather than 404'd. An invoice is legally issued the moment it is numbered, so a render that failed at issue is logged and does not unissue it — which leaves a real state in which the document exists and its rendering does not. This endpoint renders it, stores it and serves it, so the next reader is served from storage. The document is a rendering of the invoice row and nothing else; regenerating it changes no figure on the invoice.

A DRAFT has no PDF and never will: it carries no invoice number, and a document that looks like a numbered tax invoice without being one can be forwarded, filed and paid against. That is a 409, not a 404 — the invoice exists, the document does not.

curl -X GET 'https://partner-api.elivaas.com/v1/invoices/{id}/pdf' \
  -u "$ELIVAAS_API_KEY:" \
  -H 'Content-Type: application/json'

const res = await fetch('https://partner-api.elivaas.com/v1/invoices/{id}/pdf', {
  method: 'GET',
  headers: {
    Authorization: 'Basic ' + Buffer.from(process.env.ELIVAAS_API_KEY + ':').toString('base64'),
    'Content-Type': 'application/json',
  },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

import os, requests
res = requests.get(
    "https://partner-api.elivaas.com/v1/invoices/{id}/pdf",
    auth=(os.environ["ELIVAAS_API_KEY"], ""),
    timeout=30,
)
res.raise_for_status()
data = res.json()

Path parameters#

idstring<uuid>required

The invoice id.

Responses#

See Errors for the error body shape and which statuses are worth retrying.