API Docs / Schemas / CreateProposalRequest

CreateProposalRequest

Request DTO for creating a new 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

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: The system will create a historical snapshot of each ClientBillableService at its current state.
This snapshot is stored as JSON and preserves the service details even if the original
ClientBillableService is later modified or deleted.

The snapshot includes: name, description, price, billing frequency, start/end dates, and the
ClientBillableServiceCode for reference.

Example: ["CBS001", "CBS002", "CBS003"]

List of ClientBillableService codes to include in this proposal.

IMPORTANT: The system will create a historical snapshot of each ClientBillableService at its current state.
This snapshot is stored as JSON and preserves the service details even if the original
ClientBillableService is later modified or deleted.

The snapshot includes: name, description, price, billing frequency, start/end dates, and the
ClientBillableServiceCode for reference.

Example: ["CBS001", "CBS002", "CBS003"]

JSON Example

{
  "clientCode": "string",
  "date": "2024-01-01",
  "recipientFirstName": "string",
  "recipientLastName": "string",
  "recipientEmail": "string"
}

Used By Operations