API Docs / Operations / Engagements / Upload letter of engagement PDF

Upload letter of engagement PDF

POST /tenants/{tenant}/engagements/{code}/pdf/letter-of-engagement

Uploads a letter of engagement PDF document for the engagement.

The PDF should be sent as a base64-encoded string in the request body.

Request body example:
{
"pdfContent": "JVBERi0xLjQKJeLj..." // Base64-encoded PDF content
}

The uploaded PDF will be stored in Azure Blob Storage and associated with this engagement.
The engagement's HasLofEPdf flag will be set to true upon successful upload.

You can retrieve this PDF later using the GET /{code}/pdf/letter-of-engagement endpoint.

Note: Uploading a new PDF will replace any existing letter of engagement for this engagement.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

code* path string
{
  "pdfContent": "string"
}

Responses

200 OK
400 Bad Request
401 Unauthorized - Invalid or missing API key
404 Not Found