API Docs / Schemas / UpdateProposalRequest

UpdateProposalRequest

Request DTO for updating an existing proposal

Properties

Name Type Description
clientCode*string

Code of the client this proposal belongs to

Code of the client this proposal belongs to

date*string

Date of the proposal

Date of the proposal

statusenum

Unsent Sent Viewed Accepted Rejected

Unsent Sent Viewed Accepted Rejected

manuallyAcceptedboolean

Indicates whether the proposal was manually accepted (true) or accepted via the online acceptance page (false).
Only relevant when Status is set to Accepted.

Indicates whether the proposal was manually accepted (true) or accepted via the online acceptance page (false).
Only relevant when Status is set to Accepted.

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

proposalTemplateCodestring

Code of the template to use for the proposal document

Code of the template to use for the proposal document

lofETemplateCodestring

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

clientBillableServiceCodesarray of string

List of ClientBillableService codes to include in this proposal.

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 proposal 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 proposal.

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 proposal 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",
  "manuallyAccepted": false,
  "recipientFirstName": "string"
}

Used By Operations