academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Documents → Generate and download a lectureship document PDF

AI-generated

Summary

Generate and download a lectureship document PDF by sending the supplied document data to the academyFIVE API. The response is returned as a binary file on the data property, with file metadata in the JSON output.

Inputs

  • data (required) — Document data object. Requires type, id, and attributes.
  • data.attributes.lectureshipId (required) — Lectureship ID to generate the document for.
  • data.attributes.lectureshipInvoiceId — Invoice ID associated with the lectureship, if applicable.
  • data.attributes.customProperties — JSON object of custom document properties; if empty, the API uses its default values.

Output shape

One item per input item, containing binary PDF data and JSON metadata.

Binary content is stored at binary.data. JSON includes mimeType, fileName, response headers, and statusCode; the filename is taken from the response headers or request URL when available.

Links

Discussion