EngagementDto

Response DTO for engagement information

Properties

Name	Type	Description
code	string
guid	string	Unique identifier for this engagement
Unique identifier for this engagement
client	CodeAndNameDto
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
typeName	string	Display name for the engagement type ("Proposal" or "Engagement Letter")
Display name for the engagement type ("Proposal" or "Engagement Letter")
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
hasProposalPdf	boolean	Indicates whether a proposal PDF has been uploaded
Indicates whether a proposal PDF has been uploaded
hasLofEPdf	boolean	Indicates whether a letter of engagement PDF has been uploaded
Indicates whether a letter of engagement PDF has been uploaded
proposalTemplate	CodeAndNameDto
lofETemplate	CodeAndNameDto
acceptance	AcceptanceDto
lastViewed	string	Date and time when the engagement was last viewed
Date and time when the engagement was last viewed
totalValue	number	Total value of all services in this engagement (annualised recurring + one-off fees)
Total value of all services in this engagement (annualised recurring + one-off fees)
monthlyTotal	number	Sum of monthly service prices (per-month amount, not annualised)
Sum of monthly service prices (per-month amount, not annualised)
quarterlyTotal	number	Sum of quarterly service prices (per-quarter amount)
Sum of quarterly service prices (per-quarter amount)
annualTotal	number	Sum of annual service prices
Sum of annual service prices
oneOffTotal	number	Sum of one-off service prices
Sum of one-off service prices
numberOfServices	integer	Number of services included in this engagement
Number of services included in this engagement
proposalServices	array of ClientBillableServiceDto	List of services included in this engagement. These are historical snapshots of ClientBillableServices at the time of engagement creation. The original ClientBillableServices may have been modified or deleted since this engagement was created.
List of services included in this engagement. These are historical snapshots of ClientBillableServices at the time of engagement creation. The original ClientBillableServices may have been modified or deleted since this engagement was created.
proposalPdfUrl	string	Signed URL for streaming the proposal PDF without authentication. Only populated when HasProposalPdf is true.
Signed URL for streaming the proposal PDF without authentication. Only populated when HasProposalPdf is true.
lofEPdfUrl	string	Signed URL for streaming the letter of engagement PDF without authentication. Only populated when HasLofEPdf is true.
Signed URL for streaming the letter of engagement PDF without authentication. Only populated when HasLofEPdf is true.
link	string	Public link for accepting this engagement. Format: {WebApp.BaseUrl}/engagements/accept/{Guid} This is a computed property and is not persisted in the database.
Public link for accepting this engagement. Format: {WebApp.BaseUrl}/engagements/accept/{Guid} This is a computed property and is not persisted in the database.

JSON Example

{
  "code": "string",
  "guid": "00000000-0000-0000-0000-000000000000",
  "client": {
    "code": "string",
    "name": "string"
  },
  "date": "2024-01-01",
  "status": "Unsent"
}

EngagementDto

Properties

JSON Example

Used By Operations

Contained in Schemas