Proposals

Proposals are sales quotes attached to deals, presenting scope and pricing for client review and e-signature. A proposal mirrors the deal's sections and services in a client-facing layout with a pricing breakdown and acceptance workflow.

Track proposal status, send for signing, and record approvals through these endpoints.

Attributes

audit_pdf_url string
Response

URL of the audit trail PDF for this proposal, capturing signature and viewing history.

budget_total object
Response Parameter `filter`

The total budget amount of this proposal in the proposal's currency.

budget_total_default object
Response

The total budget amount of this proposal in the organization's default currency.

budget_total_normalized object
Response

The total budget amount of this proposal in the normalized (reporting) currency.

client company
Response

The client company this proposal is addressed to.

company_id integer
Parameter `filter`

ID of the client company associated with this proposal.

contact person
Response

The contact person this proposal is addressed to.

created_at string
Response Parameter `filter`

Timestamp when this proposal was created.

creator person
Response

The person who created this proposal.

creator_id integer
Parameter `filter`

ID of the person who created this proposal.

currency string
Response

The currency code used for amounts in this proposal.

currency_default object
Response

The organization's default currency code.

currency_normalized object
Response

The normalized (reporting) currency code used across the organization.

custom_fields object
Response

Custom field values for this proposal.

date string
Response

Date when this proposal was issued.

deal deal
Response

The deal (sales opportunity) this proposal belongs to.

deal_creator person
Response

The person who created the deal associated with this proposal.

deal_id integer
Parameter `filter`

The ID of the deal this proposal belongs to.

disclaimer string
Response

The optional disclaimer text appended to the proposal.

disclaimer_enabled boolean
Response

When true, the disclaimer text is shown on the proposal.

document_type document type
Response

The document type template applied to this proposal for PDF generation.

end_date string
Response

The end date of the proposal's validity or service period.

exchange_date string
Response

The date used to determine the exchange rate applied to this proposal.

exchange_rate number
Response

The exchange rate used to convert proposal amounts to the billing currency.

footer object
Response

The footer text template for the proposal, may contain interpolation variables.

footer_interpolated object
Response

The footer text with all interpolation variables resolved.

id integer
Parameter `filter`

Unique identifier for the proposal.

link_status string
Response Parameter `filter` Enum

The public sharing link status of the proposal (e.g. active, disabled).

Enum Values (2 values)

  • active
    Active
  • inactive
    Inactive
name string
Response

The display name of the proposal.

note string
Response

The body text of the proposal note, may contain interpolation variables.

note_interpolated object
Response

The proposal note with all interpolation variables resolved.

organization organization
Response

The organization this proposal belongs to.

original_pdf_url string
Response

The URL of the generated PDF for this proposal.

project project
Response

The project associated with this proposal.

proposal_from contact entry
Response

The sender details (subsidiary contact) shown on the proposal.

proposal_to contact entry
Response

The recipient details (client contact) shown on the proposal.

public_uuid string
Response

The unique public UUID used to generate the proposal's public sharing link.

purchase_order_number string
Response

The client's purchase order number associated with this proposal.

responder_email string
Response

The email address of the person who responded to (signed) the proposal.

responder_name string
Response

The name of the person who responded to (signed) the proposal.

responsible person
Response

The project manager responsible for this proposal.

responsible_id integer
Parameter `filter`

ID of the person responsible for this proposal.

sent_at string
Response Parameter `filter`

Timestamp when the proposal was sent to the client.

signed object
Response

When true, the proposal has been signed by the client.

status string
Response Parameter `filter` Enum

The current status of the proposal (e.g. draft, sent, approved, rejected).

Enum Values (4 values)

  • draft
    Draft
  • sent
    Sent
  • accepted
    Accepted
  • rejected
    Rejected
status_changed_at string
Response Parameter `filter`

Timestamp when the proposal status last changed.

subsidiary subsidiary
Response

The subsidiary (legal entity) issuing this proposal.

tax_rate tax rate
Response

The tax rate applied to proposal line items.

updated_at string
Parameter `filter`

Timestamp of the last update to this proposal.