CreateEngagementRequest
Request DTO for creating a new 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 | ||
| type* | enum | ProposalAndEngagementLetter EngagementLetter |
ProposalAndEngagementLetter EngagementLetter | ||
| 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: The system will create a historical snapshot of each ClientBillableService at its current state. The snapshot includes: name, description, price, billing frequency, start/end dates, and the Example: ["CBS001", "CBS002", "CBS003"] |
List of ClientBillableService codes to include in this engagement. IMPORTANT: The system will create a historical snapshot of each ClientBillableService at its current state. The snapshot includes: name, description, price, billing frequency, start/end dates, and the Example: ["CBS001", "CBS002", "CBS003"] | ||
JSON Example
{
"clientCode": "string",
"date": "2024-01-01",
"type": "ProposalAndEngagementLetter",
"recipientFirstName": "string",
"recipientLastName": "string"
}