API Docs / Schemas / ProposalDto

ProposalDto

Response DTO for proposal information

Properties

Name Type Description
codestring

Unique code for this proposal (auto-generated based on date)

Unique code for this proposal (auto-generated based on date)

guidstring

Unique identifier for this proposal

Unique identifier for this proposal

clientCodeAndNameDto
datestring

Date of the proposal

Date of the proposal

statusenum

Unsent Sent Viewed Accepted Rejected

Unsent Sent Viewed Accepted Rejected

recipientFirstNamestring

First name of the recipient for this proposal

First name of the recipient for this proposal

recipientLastNamestring

Last name of the recipient for this proposal

Last name of the recipient for this proposal

recipientEmailstring

Email address of the recipient for this proposal

Email address of the recipient for this proposal

hasProposalPdfboolean

Indicates whether a proposal PDF has been uploaded

Indicates whether a proposal PDF has been uploaded

hasLofEPdfboolean

Indicates whether a letter of engagement PDF has been uploaded

Indicates whether a letter of engagement PDF has been uploaded

proposalTemplateCodeAndNameDto
lofETemplateCodeAndNameDto
acceptanceAcceptanceDto
lastViewedstring

Date and time when the proposal was last viewed

Date and time when the proposal was last viewed

annualValuenumber

Total annual value of all services in this proposal

Total annual value of all services in this proposal

numberOfServicesinteger

Number of services included in this proposal

Number of services included in this proposal

proposalServicesarray of ClientBillableServiceDto

List of services included in this proposal.
These are historical snapshots of ClientBillableServices at the time of proposal creation.
The original ClientBillableServices may have been modified or deleted since this proposal was created.

List of services included in this proposal.
These are historical snapshots of ClientBillableServices at the time of proposal creation.
The original ClientBillableServices may have been modified or deleted since this proposal was created.

linkstring

Public link for accepting this proposal.
Format: {WebApp.BaseUrl}/proposals/accept/{Guid}
This is a computed property and is not persisted in the database.

Public link for accepting this proposal.
Format: {WebApp.BaseUrl}/proposals/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"
}

Used By Operations

Contained in Schemas