Engagements
Comprehensive engagement creation, management, and client communication. Provides CRUD operations with filtering by status, client, and search terms. Includes specialized endpoints for uploading and downloading proposal PDFs and letters of engagement (base64-encoded content), sending engagement emails using configured templates with tracking, and retrieving email history for engagements. Engagements capture a snapshot of ClientBillableServices at a point in time.
-
GET List EngagementsLists all Engagements for the given tenant./tenants/{tenant}/engagements
-
POST Create EngagementCreates a new Engagement for the specified tenant./tenants/{tenant}/engagements
-
GET Get EngagementGets a Engagement for the specified tenant./tenants/{tenant}/engagements/{code}
-
PUT Update EngagementUpdates a Engagement for the specified tenant./tenants/{tenant}/engagements/{code}
-
DELETE Delete EngagementDeletes a Engagement for the specified tenant./tenants/{tenant}/engagements/{code}
-
POST Email EngagementSends an email for the engagement using the tenant's email settings. The email will be sent to the recipient specified in the engagement. The email w.../tenants/{tenant}/engagements/{code}/email
-
GET Get Engagement EmailsGets all emails that have been sent for a specific engagement. Returns a list of emails with their message IDs and sent dates. The list is ordered by.../tenants/{tenant}/engagements/{code}/email
-
POST Upload proposal PDFUploads a PDF document for the proposal. The PDF should be sent as a base64-encoded string in the request body. Request body example: { "pdfConten.../tenants/{tenant}/engagements/{code}/pdf/proposal
-
GET Download proposal PDFDownloads the proposal PDF document. Returns the PDF file as binary content with appropriate headers for download. The response will include a Conten.../tenants/{tenant}/engagements/{code}/pdf/proposal
-
POST Upload letter of engagement PDFUploads 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 .../tenants/{tenant}/engagements/{code}/pdf/letter-of-engagement
-
GET Download letter of engagement PDFDownloads the letter of engagement PDF document. Returns the PDF file as binary content with appropriate headers for download. The response will incl.../tenants/{tenant}/engagements/{code}/pdf/letter-of-engagement