Generate a PDF
This endpoint is available to Group API Keys only.
Triggers the asynchronous generation of a PDF document (e.g., an invoice PDF or a rabies certificate). The response includes a unique key that can be used to poll the fetch endpoint until the PDF is ready for download. Once ready for download, PDFs are only available for download for 24 hours. Beyond that window, the PDF must be regenerated.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- ExternalPDFInvoiceSchema
- ExternalPDFRabiesCertificateSchema
- ExternalPDFPatientTimelineSchema
Schema for generating an invoice PDF
The ID of the invoice to generate the PDF for
The kind of PDF to generate
"INVOICE"The ID of the patient to generate the PDF for, leave blank to include all patients
Whether to include discharge notes
Whether to include upcoming invoices
Deprecated: Use clinic_patient_id instead.
Response
Created
Schema for the PDF detail view
An error message if the PDF generation failed. Null on success.
The filename of the generated PDF document.
A pre-signed URL to download the generated PDF. Null if the PDF is still being generated or generation failed.
The unique key used to identify and retrieve this generated PDF.
A human-readable name describing the type of PDF that was generated.
The current generation status of the PDF.
PENDING, SUCCESS, ERROR