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

approval_requested_at string
Response Nullable

[DESCRIPTION]
approval_requester person
Response

[DESCRIPTION]
approval_status string
Response Parameter `filter` Enum

[DESCRIPTION]

Enum Values (4 values)

  • approved
    Approved
  • unapproved
    Unapproved
  • rejected
    Rejected
  • auto_approved
    Auto approved
approval_statuses array of approval status
Response

[DESCRIPTION]
approved_at string
Response Nullable

[DESCRIPTION]
approved_by_actual_approver_id integer
Parameter `filter`

[DESCRIPTION]
approved_for_assigned_approver_id integer
Parameter `filter`

[DESCRIPTION]
attachment attachment
Response

[DESCRIPTION]
awaiting_approval_from_approver_id integer
Parameter `filter`

[DESCRIPTION]
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.
decline_reason string
Response Nullable

[DESCRIPTION]
disclaimer string
Response

The optional disclaimer text appended to the proposal.
disclaimer_accepted boolean
Request

[DESCRIPTION]
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.
identity_confirmation_enabled boolean
Response

[DESCRIPTION]
identity_confirmed_at string
Response Nullable

[DESCRIPTION]
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.
number string
Response Nullable

[DESCRIPTION]
organization organization
Response

The organization this proposal belongs to.
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_pdf_preview_on_mobile boolean
Response

[DESCRIPTION]
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.
rejected_at string
Response Nullable

[DESCRIPTION]
rejected_reason string
Response Nullable

[DESCRIPTION]
rejecter person
Response

[DESCRIPTION]
responded_via_public_link boolean
Response Nullable

[DESCRIPTION]
responder_email string
Response Nullable

The email address of the person who responded to (signed) the proposal.
responder_name string
Response Nullable

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.
scenario scenario
Response

The scenario this proposal was created from; set when the proposal's source is a scenario.
sent_at string
Response Parameter `filter`

Timestamp when the proposal was sent to the client.
signature_image_url string
Request

[DESCRIPTION]
signature_type string
Request Enum

[DESCRIPTION]

Enum Values (3 values)

  • typed
    Typed
  • drawn
    Drawn
  • uploaded
    Uploaded
signed object
Response

When true, the proposal has been signed by the client.
signed_pdf_url string
Response

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

[DESCRIPTION]

Enum Values (3 values)

  • deal
    Deal
  • scenario
    Scenario
  • upload
    Upload
status string
Response Parameter `filter` Enum

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

Enum Values (6 values)

  • draft
    Draft
  • pending_approval
    Pending approval
  • approved
    Approved
  • sent
    Sent
  • accepted
    Accepted
  • declined
    Declined
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.

Examples

Loading example

Operations

GET /api/v2/proposals
Get proposals
POST /api/v2/proposals
Create a proposal
PATCH /api/v2/proposals/bulk_approve
Bulk approves proposals on behalf of the current person
GET /api/v2/proposal_services
Get proposal services
GET /api/v2/proposal_sessions
Get proposal sessions
DELETE /api/v2/proposals/{id}
Deletes a proposal
GET /api/v2/proposals/{id}
Gets a proposal
PATCH /api/v2/proposals/{id}
Update a proposal
PATCH /api/v2/proposals/{id}/approve
Approves a proposal on behalf of an approver
PATCH /api/v2/proposals/{id}/publish
Publish a proposal through its public link
PATCH /api/v2/proposals/{id}/reject
Rejects a proposal on behalf of an approver
PATCH /api/v2/proposals/{id}/send
Send a proposal by email
POST /api/v2/proposals/{id}/send_approval_mail
Send the proposal approval email
GET /api/v2/proposals/{id}/signed_pdf
Get a download URL for the signed proposal PDF
PATCH /api/v2/proposals/{id}/sync
Sync a proposal
GET /api/v2/proposals/{id}/sync_status
Get proposal's sync status
PATCH /api/v2/proposals/{id}/unapprove
Unapproves a proposal on behalf of an approver
GET /api/v2/public/proposals/{uuid}
Show a public proposal
PATCH /api/v2/public/proposals/{uuid}/accept
Accept a public proposal
PATCH /api/v2/public/proposals/{uuid}/confirm_identity
Confirm identity for a public proposal
PATCH /api/v2/public/proposals/{uuid}/decline
Decline a public proposal
GET /api/v2/public/proposals/{uuid}/file_authorize
Authorize access to a public proposal file
POST /api/v2/public/proposals/{uuid}/file_presign
Pre-sign a signature image upload for a public proposal
POST /api/v2/public/proposals/{uuid}/unlock
Unlock a password-protected public proposal