GuidesAPI ReferenceDiscussions
API Reference

Produce a Templated Document

post
https://api.servicem8.com/platform_produce_document

Use this endpoint to combine Objects with Document Templates to produce PDF, DOCX or JPG output. Specify the request parameters as a JSON object in the body of the request.

If everything went smoothly, the response will contain a copy of the produced document in the output format you requested. Otherwise, the response will be a JSON object describing the error which occured.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The type of record to produce the template regarding (e.g. Job)

uuid
required

The record uuid to produce the template regarding. For a job record, this will be the job record's uuid.

string
enum
required

The type of template you would like to produce, can be “Quote”, “Work Order”, “Invoice”.

Allowed:
uuid

If you have multiple template designs for a given template type, specify the template UUID to determine which template will be used to produce your document. The templateUUID field is optional, if you do not specify a template UUID, your default template for the given template type will automatically be used. You can lookup available templateUUID by querying the DocumentTemplate endpoint.

string
enum
required

The output filetype you wish to receive your document template as, can be “pdf”, “docx” or “jpg”

Allowed:
boolean

Set this value to true if you would like a copy of the produced document template to be automatically attached to the job diary.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/octet-stream

Updated 10 months ago