UpdateEngagementRequest

Request DTO for updating an existing engagement

Properties

Name	Type	Description
clientCode*	string	Code of the client this engagement belongs to
Code of the client this engagement belongs to
date*	string	Date of the engagement
Date of the engagement
status	enum	Unsent Sent Viewed Accepted Rejected
Unsent Sent Viewed Accepted Rejected
type	enum	ProposalAndEngagementLetter EngagementLetter
ProposalAndEngagementLetter EngagementLetter
manuallyAccepted	boolean	Indicates whether the engagement was manually accepted (true) or accepted via the online acceptance page (false). Only relevant when Status is set to Accepted.
Indicates whether the engagement was manually accepted (true) or accepted via the online acceptance page (false). Only relevant when Status is set to Accepted.
recipientFirstName	string	First name of the recipient for this engagement
First name of the recipient for this engagement
recipientLastName	string	Last name of the recipient for this engagement
Last name of the recipient for this engagement
recipientEmail	string	Email address of the recipient for this engagement
Email address of the recipient for this engagement
proposalTemplateCode	string	Code of the template to use for the proposal document
Code of the template to use for the proposal document
lofETemplateCode	string	Code of the template to use for the letter of engagement (LofE) document
Code of the template to use for the letter of engagement (LofE) document
clientBillableServiceCodes	array of string	List of ClientBillableService codes to include in this engagement. IMPORTANT: Updating this field will replace ALL existing service snapshots with new ones. The system will create fresh snapshots of each ClientBillableService at its current state. This allows you to update the engagement if service pricing or details have changed. The historical snapshots are stored as JSON and preserve service details even if the original ClientBillableService is later modified or deleted. Example: ["CBS001", "CBS002", "CBS003"]
List of ClientBillableService codes to include in this engagement. IMPORTANT: Updating this field will replace ALL existing service snapshots with new ones. The system will create fresh snapshots of each ClientBillableService at its current state. This allows you to update the engagement if service pricing or details have changed. The historical snapshots are stored as JSON and preserve service details even if the original ClientBillableService is later modified or deleted. Example: ["CBS001", "CBS002", "CBS003"]

JSON Example

{
  "clientCode": "string",
  "date": "2024-01-01",
  "status": "Unsent",
  "type": "ProposalAndEngagementLetter",
  "manuallyAccepted": false
}

Used By Operations

PUT Update Engagement
/tenants/{tenant}/engagements/{code}