Document API

The document API allows you to produce the same PDF documents that are output from the admin panel, via the API

POST {root}/pdf/{entityname}/{templatename}/{id}

  • The standard way to output a single PDF from a record, using the name of the template that should be used

  • Refer to the admin panel for the names of available templates for each entity

POST {root}/pdf/bulkrpc/{templatename}/{id}

  • A special route for outputting multiple PDFs for multiple records in one call.

  • A 'bulk rpc report' using the 'print' action must first be created (which can be done via the API) - this dictates which records are included in the bulk print

  • Once the ID of the bulk RPC report is obtained, use this endpoint to ouput PDFs for all records that were included in the bulk report.

Last updated