API Docs / Schemas / ExternalProposalDto

ExternalProposalDto

A proposal from an external platform (Socket, etc.)

Properties

Name Type Description
idstring

External platform ID

External platform ID

proposalNumberstring

Human-readable reference number (e.g., P-001234)

Human-readable reference number (e.g., P-001234)

titlestring

Optional title

Optional title

statusstring

Current status on the external platform

Current status on the external platform

pricenumber

Total price

Total price

recurringPricenumber

Recurring component of the price

Recurring component of the price

oneOffPricenumber

One-off component of the price

One-off component of the price

currencystring

ISO 4217 currency code

ISO 4217 currency code

plannedStartstring

Planned start date

Planned start date

endDatestring

End date

End date

createdAtstring

When the proposal was created

When the proposal was created

clientNamestring

Primary client name on the external platform

Primary client name on the external platform

clientIdstring

Primary client ID on the external platform

Primary client ID on the external platform

externalUrlstring

URL to view/edit the proposal on the external platform

URL to view/edit the proposal on the external platform

approvalLinkstring

URL for the client to approve the proposal

URL for the client to approve the proposal

versioninteger

Version number

Version number

contactNamestring

Primary contact name

Primary contact name

contactEmailstring

Primary contact email

Primary contact email

linesarray of ExternalProposalLineDto

Line items on the proposal (populated on detail only)

Line items on the proposal (populated on detail only)

importedClientCodeAndNameDto
hasServicesAssignedboolean

Whether the imported client has services from this proposal assigned.
True when at least one mapped service exists on the client.

Whether the imported client has services from this proposal assigned.
True when at least one mapped service exists on the client.

JSON Example

{
  "id": "string",
  "proposalNumber": "string",
  "title": "string",
  "status": "string",
  "price": 0
}

Used By Operations

Contained in Schemas