API Docs

Quick Links

Base URLhttps://web.smartpricingtable.com/api

Beta

This API is in beta. Endpoints and response shapes may change as we iterate. For questions or feedback, email support@smartpricingtable.com.

Authentication

API Key Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can create and manage API keys from your profile settings.

Pagination

List endpoints return paginated results. Include page and limit query parameters to control which page of results you receive.

Request Parameters

Parameter	Type	Default	Description
page	integer	1	Page number (starts at 1)
limit	integer	20	Items per page (1–100)

Response Format

Every list response includes a pagination object alongside the data array:

{
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

Proposals(17)

GET/proposals

ListProposals

Retrieve a paginated list of proposals for the authenticated user's organization. Templates are excluded by default. Pass `is_template=true` to list reusable templates instead of regular proposals (not both). Use a returned template's `id` with `POST /api/proposals` (`templateId`) to create a proposal from that template.

Query Parameters

archivedenum

falsedefaulttrueany

Filter by archive status (false=non-archived, true=archived only, any=both)

created_bystring

Filter by creator's public_id

is_templateboolean

Default: false. When true, return only template proposals (reusable templates). When omitted or false, templates are excluded and only regular proposals are returned.

limitinteger

Default: 20. Number of items per page

orderenum

descdefaultasc

Sort order

pageinteger

Default: 1. Page number for pagination

searchstring

Search term to filter proposals by name or client

sortenum

created_atdefaultupdated_atnamestatusclient_namesentexpiring_oncompletedlast_activity

Field to sort by. Date sorts (sent, expiring_on, completed, last_activity) push proposals missing that date to the end; last_activity is the most recent recipient-facing engagement.

statusenum

draftsentwonlostcancelled

Filter by proposal status

Responses

200Successful response with proposals list

dataarray of ProposalListItem

paginationPagination

Example

{
  "data": []
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals

CreateProposal

Create a new proposal for the user's organization. To start from a template, first call GET /api/proposals?is_template=true and copy the template id. Then POST that id as templateId, along with name and the client under settings.recipient. The new proposal is a copy of the template. Pages, pricing, and design come from the template. settings.recipient replaces the template's client. settings.recipient.name is the company name. settings.recipient.contact.name, contact.email, and contact.phone are the person. address and website are optional. Only the settings keys you send replace the template; everything else stays. Omit templateId to create a blank proposal. Set is_template to true to create a reusable template instead of a proposal. A default send email saved on your template is copied onto the new proposal as settings.template_send_email (subject and message, no signature). Send that email with POST /api/proposals/{id}/send-email. To link the new proposal to a CRM record, pass integrations.crm.provider and integrations.crm.deal_id. provider is hubspot, pipedrive, zoho, or gohighlevel. deal_id is that record's id in the CRM (a HubSpot, Pipedrive, or Zoho deal, or a Go High Level opportunity). The organization must already have that CRM connected. The record is looked up and linked. Name matching is not used. Recipient fields are not copied from the CRM; send settings.recipient when the client should be filled in. The proposal URL is written to the field configured in Integrations, and the proposal total syncs to the deal value. When the account has Add tax from CRM turned on, a HubSpot deal's tax rate is written onto the new proposal's pricing pages. salesTaxPercentage on this request wins over that rate.

Request Body

namestringrequired

Proposal title. Required even when creating from a template.

templateIdstring

Public id of a template. Get it from GET /api/proposals?is_template=true. The new proposal copies that template. Omit to create a blank proposal.

is_templateboolean

Set true to create a reusable template instead of a proposal. Leave unset or false when creating a proposal from a template.

settingsobject

Proposal settings. When creating from a template, only the keys you send replace the template values. recipient replaces the template client entirely.

integrationsobject

Optional. Link this proposal to a CRM record when it is created. The organization must already have that CRM connected.

Example

{
  "name": "Acme website redesign",
  "templateId": "zw5FD5HGcfE3",
  "settings": {
    "recipient": {
      "name": "Acme Co",
      "address": "123 Main St, Tulsa, OK",
      "website": "https://acme.example",
      "contact": {
        "name": "Jane Smith",
        "email": "jane@acme.example",
        "phone": "555-0100"
      }
    }
  }
}

Responses

201Proposal created successfully

dataobject

idstring

Unique identifier for the created proposal

Example

{
  "data": {
    "id": "example-string"
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}

GetProposal

Retrieve detailed information about a specific proposal including all items and groups. For an importable backup matching More → Export as JSON in the app, use GET /api/proposals/{id}/export instead.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal retrieved successfully

object

Example

null

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Proposal not found"
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/proposals/{id}

UpdateProposal

Update proposal details such as name, description, or client information

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

object

Example

null

Responses

200Proposal updated successfully

object

Example

null

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/proposals/{id}

DeleteProposal

Delete a proposal and all its associated items. The proposal will no longer appear in listings.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal deleted successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}/analytics

GetProposalAnalytics

Retrieve analytics events for a specific proposal. Requires authentication and membership in the proposal's organization (or platform admin).

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Query Parameters

end_datestring

Filter events up to this date

event_typeenum

proposal_viewedproposal_sentstatus_changedproposal_signedpdf_viewedsignature_request_sent

Filter by event type

limitinteger

Default: 50. Maximum number of events to return

offsetinteger

Default: 0. Number of events to skip for pagination

start_datestring

Filter events from this date onwards

Responses

200Analytics events retrieved successfully

dataarray of object

event_timestampstring

event_typestring

idstring

metadataobject

userobject

Example

{
  "data": [
    {
      "event_timestamp": "2024-01-20T15:30:00Z",
      "event_type": "example-string",
      "id": "example-string",
      "metadata": {},
      "user": {
        "email": "example-string",
        "full_name": "example-string",
        "public_id": "example-string"
      }
    }
  ]
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/archive

ArchiveProposal

Archive a proposal by setting its archived_at timestamp. Archived proposals are excluded from default listings and become read-only.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal archived successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to archive this proposal

errorstring

Example

{
  "error": "Not authorized to archive this proposal"
}

404Proposal not found

errorstring

Example

{
  "error": "Proposal not found"
}

409Proposal is already archived

errorstring

Example

{
  "error": "Proposal is already archived"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/bulk-archive

BulkArchiveItems

Archive multiple items (line items, groups) from a proposal

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

itemIdsarray of stringrequired

Array of item IDs to archive

Example

{
  "itemIds": [
    "abcdefgh1234",
    "ijklmnop5678"
  ]
}

Responses

200Items archived successfully

archivedCountinteger

Number of items successfully archived

errorsarray of string

Array of error messages for failed items (only present if some items failed)

messagestring

Success message

Example

{
  "archivedCount": 3,
  "errors": [
    "example-string"
  ],
  "message": "Successfully archived 3 items"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/duplicate

DuplicateProposal

Create a complete copy of an existing proposal with all its groups, items, and pages

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

namestring

Name for the duplicated proposal. Default: "Copy of {original name}"

Example

{
  "name": "Copy of Q1 2024 Proposal"
}

Responses

201Proposal duplicated successfully

dataobject

idstring

ID of the newly created proposal

Example

{
  "data": {
    "id": "example-string"
  }
}

400Validation error

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}/export

ExportProposalJSON

Download a proposal or template as the same importable JSON file produced by More → Export as JSON in the app. Save the response body and import it with Create Proposal → Import from JSON — no transformation needed. The response is the export object itself (not wrapped in a data envelope). Non-portable fields such as signature state, payment sessions, and email drafts are stripped, and status is set to DRAFT, matching the in-app export.

Path Parameters

idstringrequired

Proposal or template ID

e.g., zw5FD5HGcfE3

Responses

200Importable proposal or template JSON — the same file you get from More → Export as JSON in the app. Ready to import via Create Proposal → Import from JSON.

designobject

Design settings included in the export

idstring

Source proposal or template ID

is_templateboolean

Whether this export is a template

namestring

Proposal or template name

pagesarray of object

Pages, including scope-of-work content, groups, and line items

settingsobject

Proposal settings included in the export

statusstring

Always DRAFT in exports

Example

{
  "name": "example-string",
  "pages": [
    {}
  ],
  "design": {},
  "id": "example-string",
  "is_template": true,
  "settings": {},
  "status": "DRAFT"
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found or not authorized

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string"
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/items

PostProposalsItems

Create a brand-new line item, group, or side-by-side directly inside a proposal (not copied from the library). A line item is added to a group (target_group_id, or the first group by default); a group or side-by-side is added under a Scope of Work page (scope_of_work_page_id, or the first one by default). Pass after_item_id / before_item_id to position the new item relative to an existing one — it then inherits that item's parent. To create a side-by-side on a proposal, send type=side_by_side with a non-empty columns array. To save one in the library instead, POST /api/library/side-by-sides. Each column price is a number in dollars (default 0). Side-by-sides have no URL of their own; to change one later, PATCH /api/items/{id} with an { "item": { ... } } body. Prices are in dollars (major currency units), not cents. Color theme: set theme to a built-in id (metals, ocean, forest, sunset, monochrome, pastel, neon, earth, berry, corporate) or design for a custom theme. theme paints column colors (cycled), the container, and — when style is comparison — the features column and headings. design.container, design.featuresColumn, design.heading, and design.columns (a cycled palette) are the custom settings. A design object on an individual column overrides that column. Send design with theme to start from a built-in theme and override pieces of it.

Path Parameters

idstringrequired

Public ID of the proposal.

Request Body

typeenumrequired

The kind of item to create.

line_itemgroupside_by_side

namestringrequired

Display name of the item.

descriptionstring

Optional rich-text/HTML description (stored as the item's content).

priceobject

Required for type=line_item. Pricing definition, for example { "model": "fixed", "value": 379, "frequency": "once" }. To change it later, PATCH /api/items/{id} with a new price.

optionalboolean

Whether the item is optional (client can toggle it).

selectedboolean

Whether an optional item is selected by default.

tagsarray of string

Tags to attach to the item.

target_group_idstring

For type=line_item. Group to add into (default first group).

scope_of_work_page_idstring

For type=group or side_by_side. Scope of Work page to add under (default first SOW page).

columnsarray of object

Required for type=side_by_side. The selectable packages/columns. Column ids are generated server-side if omitted.

featuresarray of object

For type=side_by_side comparison style — the feature rows.

selection_typeenum

For type=side_by_side. How many columns a client may select (default loose).

singlemultipleloose

styleenum

For type=side_by_side. Layout style (default standard).

standardcomparison

themeenum

For type=side_by_side. Built-in color theme (the design drawer's Quick Themes). monochrome is the Mono theme.

metalsoceanforestsunsetmonochromepastelneonearthberrycorporate

designobject

For type=side_by_side. Custom theme. Use instead of theme, or with theme to override specific settings.

after_item_idstring

Place the new item immediately after this existing item (a line item id for type=line_item; a group/side-by-side id for type=group). Inherits that item's parent. Mutually exclusive with before_item_id.

before_item_idstring

Place the new item immediately before this existing item.

order_keynumber

Optional explicit ordering position. Defaults to appending at the end.

Example

{
  "name": "example-string",
  "type": "line_item",
  "after_item_id": "example-string",
  "before_item_id": "example-string",
  "columns": [
    {
      "name": "example-string",
      "description": "example-string",
      "design": {
        "background": "example-string",
        "borderColor": "example-string",
        "borderRadius": 100,
        "borderWidth": 100,
        "buttonColor": "example-string",
        "buttonTextColor": "example-string",
        "checkmarkColor": "example-string",
        "fontColor": "example-string",
        "priceColor": "example-string",
        "quantityBackgroundColor": "example-string",
        "quantityFontColor": "example-string",
        "titleColor": "example-string"
      },
      "feeType": "fixed",
      "frequency": "example-string",
      "includedFeatures": [
        "example-string"
      ],
      "isSelected": true,
      "price": 499
    }
  ],
  "description": "example-string",
  "design": {
    "columns": [
      {}
    ],
    "container": {
      "background": "example-string",
      "borderColor": "example-string",
      "borderWidth": 100,
      "fontColor": "example-string",
      "selectionOutlineColor": "example-string",
      "showHeader": true,
      "sizeModifier": "compact"
    },
    "featuresColumn": {
      "background": "example-string",
      "borderColor": "example-string",
      "borderRadius": 100,
      "borderWidth": 100,
      "fontColor": "example-string"
    },
    "heading": {
      "alignment": "left",
      "background": "example-string",
      "fontColor": "example-string"
    }
  },
  "features": [
    {
      "name": "example-string",
      "order_key": 100
    }
  ],
  "optional": true,
  "order_key": 100,
  "price": {
    "frequency": "once",
    "model": "fixed",
    "quantity": {
      "current": 100,
      "max": 100,
      "min": 100,
      "unitLabel": "example-string"
    },
    "value": 379
  },
  "scope_of_work_page_id": "example-string",
  "selected": true,
  "selection_type": "single",
  "style": "standard",
  "tags": [
    "example-string"
  ],
  "target_group_id": "example-string",
  "theme": "metals"
}

Responses

201Item created.

dataobject

idstring

namestring

order_keynumber

typestring

successboolean

Example

{
  "data": {
    "id": "example-string",
    "name": "example-string",
    "order_key": 100,
    "type": "example-string"
  },
  "success": true
}

400Invalid request (bad type, missing/invalid fields, or no valid parent).

403Not authorized to edit the proposal.

404Proposal (or referenced parent/position item) not found.

POST/proposals/{id}/library-insertions

PostProposalsLibraryInsertions

Copies a saved library item (line item, group, page, or side-by-side) into the specified proposal. The library item and the target proposal must belong to the same organization. The copy is always a deep, autonomous copy — it does not stay linked to or synced with the library source. Library content is never modified by this operation.

Path Parameters

idstringrequired

Public ID of the target proposal.

Request Body

typeenumrequired

The kind of library item to insert.

line_itemgrouppageside_by_side

library_item_idstringrequired

Public ID of the library item to copy.

target_group_idstring

For type=line_item only. Public ID of the group in the target proposal to add the line item to. Defaults to the first group in the proposal.

scope_of_work_page_idstring

For type=group or side_by_side. Public ID of the Scope of Work page to insert under. Defaults to the first Scope of Work page.

after_item_idstring

Place the new item immediately after this existing item. The new item inherits that item's parent (group for a line item; page for a group/side-by-side) and is given a midpoint order_key. Overrides target_group_id / scope_of_work_page_id. Mutually exclusive with before_item_id.

before_item_idstring

Place the new item immediately before this existing item. Same rules as after_item_id. Mutually exclusive with it.

order_keynumber

Optional explicit ordering position. Defaults to appending at the end.

Example

{
  "library_item_id": "example-string",
  "type": "line_item",
  "after_item_id": "example-string",
  "before_item_id": "example-string",
  "order_key": 100,
  "scope_of_work_page_id": "example-string",
  "target_group_id": "example-string"
}

Responses

201Library item inserted into the proposal.

dataobject

idstring

namestring

order_keynumber

typestring

successboolean

Example

{
  "data": {
    "id": "example-string",
    "name": "example-string",
    "order_key": 100,
    "type": "example-string"
  },
  "success": true
}

400Invalid request (missing/invalid type or required target).

403Not authorized to edit the target proposal.

404Proposal or library item not found (or not in the same organization).

POST/proposals/{id}/pdf

GenerateProposalPDF

Generate a PDF document for the specified proposal. Returns the PDF as a binary download.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

No properties

Example

{}

Responses

200PDF generated successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/send-email

SendProposalEmail

Email the proposal to one or more recipients and mark it Sent. This is the same action as Send in the app. Authenticate with a Bearer API key. The key's user must be allowed to send proposals. recipients, subject, message, and fromEmail are required. recipients is an array of { name, email }, or a comma-separated list of email addresses. fromEmail is the address shown as the sender. To send the email saved on a template: create the proposal with templateId (see Create Proposal). The template's subject and message are copied onto the new proposal as settings.template_send_email. GET the proposal, then pass those values as subject and message here, along with the client's email. The saved email signature of the API key's user is appended to message. Pass signature_user_id (a public user id belonging to this organization) to use that member's signature instead. If that person has no signature, the email still sends without one. Pass include_signature false to send message exactly as given. These tokens in subject and message are replaced for each recipient: [recipient_contact_full_name], [recipient_contact_first_name], [recipient_contact_email_address], [recipient_company_name], [recipient_address], [recipient_website], [proposal_creator_full_name], [proposal_creator_email_address], [proposal_creator_phone_number], and [view_proposal_button label="View Proposal"].

Path Parameters

idstringrequired

Proposal public id

e.g., zw5FD5HGcfE3

Request Body

recipientsunionrequired

Who receives the proposal email. An array of name and email, or a comma-separated list of email addresses.

subjectstringrequired

Email subject. Tokens such as [recipient_company_name] are replaced for each recipient.

messagestringrequired

Email body as HTML. Tokens such as [recipient_contact_first_name] are replaced for each recipient. The sender signature is appended after this HTML.

fromEmailstringrequired

Address shown as the sender.

include_signatureboolean

Append an email signature. Defaults to true. Set false to send message exactly as given.

signature_user_idstring

Public id of an organization member whose saved signature to append instead of the API key user. Ignored when include_signature is false.

Example

{
  "recipients": [
    {
      "name": "Jane Smith",
      "email": "jane@acme.example"
    }
  ],
  "subject": "Proposal for Acme Co",
  "message": "<p>Hi [recipient_contact_first_name], your proposal is ready.</p>",
  "fromEmail": "eddie@yourcompany.example"
}

Responses

200Email sent. The proposal status is Sent.

400Missing fields, an invalid email, or signature_user_id is not a member of this organization

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

409This version is not the customer-visible version, or approval is still required

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/star

StarProposal

Star a proposal for the current user. Starred proposals appear first in listings. This operation is idempotent - starring an already-starred proposal has no effect.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal starred successfully

is_starredboolean

Example

{
  "is_starred": true
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/unarchive

UnarchiveProposal

Unarchive a proposal by clearing its archived_at timestamp. The proposal will return to active status and become editable again.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal unarchived successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to unarchive this proposal

errorstring

Example

{
  "error": "Not authorized to unarchive this proposal"
}

404Proposal not found

errorstring

Example

{
  "error": "Proposal not found"
}

409Proposal is not archived

errorstring

Example

{
  "error": "Proposal is not archived"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/unstar

UnstarProposal

Remove the star from a proposal for the current user. This operation is idempotent - unstarring a proposal that is not starred has no effect.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal unstarred successfully

is_starredboolean

Example

{
  "is_starred": false
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

Pages(11)

POST/library/bulk-archive

BulkArchiveLibraryItems

Archive more than one library entry in one call. itemIds are Public IDs returned by the API (for example zw5FD5HGcfE3), not the editor Item ID field (externalItemId). Each id must belong to your organization's library. Line items, groups, and pages are accepted. Archiving hides an entry so it can be restored; it is not a permanent delete. Up to 2000 ids per request. Requires the Manage Library permission. A partial failure still returns 200: archivedCount is how many succeeded, and errors lists the rest.

Request Body

itemIdsarray of stringrequired

Public IDs of library line items, groups, or pages to archive. Not editor Item IDs (externalItemId).

Example

{
  "itemIds": [
    "zw5FD5HGcfE3",
    "kP3mNq8rT2xY"
  ]
}

Responses

200Archive finished. archivedCount can be lower than itemIds.length when errors is present.

archivedCountinteger

Number of items successfully archived

errorsarray of string

Messages for ids that were not archived. Omitted when every id succeeded.

messagestring

Success message

Example

{
  "archivedCount": 3,
  "errors": [
    "example-string"
  ],
  "message": "Successfully archived 3 items"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/pages

CreatePage

Add a page to a proposal (parent_proposal, the proposal's Public ID) or to your organization's library (in_library true). Send exactly one of the two. The page's fields go inside "page"; only page.name (the title) is required, and page.content is the HTML body. The new page is added at the end unless you send page.order_key. Example: { "parent_proposal": "zw5FD5HGcfE3", "page": { "name": "About Us", "content": "We have served clients since 2010." } }. Set page.hideSection true to create the page hidden from recipients (the editor "Hide this Page" toggle). Staff still see it; recipients do not. Hidden Scope of Work pages are left out of grand totals. This is not the same as archiving the page. Set page.excludeFromPdf true to leave the page out of PDF exports only. Set page.isScopeOfWork true to create a Scope of Work (pricing) page. It starts empty and uses your organization's pricing-table defaults. Add groups, line items, and side-by-sides to it with POST /api/proposals/{id}/items (scope_of_work_page_id set to the returned id). Proposals that are pending signature, won, or lost cannot be edited (409).

Request Body

pageobjectrequired

parent_proposalstring

Public ID of the proposal to add the page to.

in_libraryboolean

Create the page in your organization's library.

Example

{
  "page": {
    "name": "example-string",
    "children": [
      {
        "displayCost": "show_all",
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "kind": "group",
        "lineItems": [
          {
            "children": [],
            "description": "example-string",
            "discountExempt": true,
            "id": "example-string",
            "isOptional": true,
            "isSelected": true,
            "markupExempt": true,
            "name": "example-string",
            "taxExempt": true,
            "archived_at": "example-string",
            "childCount": 100,
            "created_at": "example-string",
            "externalItemId": "example-string",
            "hasLinkedItems": true,
            "hidden": true,
            "hideModifications": true,
            "in_library": true,
            "integrations": {},
            "internalNotes": "example-string",
            "is_archived": true,
            "label": "example-string",
            "linkedLibraryItemId": "example-string",
            "locked": true,
            "modificationsLabel": "example-string",
            "order_key": 100,
            "parent_id": "example-string",
            "requireSelection": true,
            "selectionType": "single",
            "showCents": true,
            "skipRounding": true,
            "startExpanded": true,
            "tags": [],
            "terms": "example-string",
            "updated_at": "example-string"
          }
        ],
        "name": "example-string",
        "selectionType": "single",
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "hidden": true,
        "hideQuantities": true,
        "in_library": true,
        "internalNotes": "example-string",
        "is_archived": true,
        "linkedScopeId": "example-string",
        "locked": true,
        "order_key": 100,
        "pdfPageBreak": true,
        "quantity": {
          "editableByRecipient": true,
          "max": 100,
          "min": 100,
          "current": 100,
          "unitLabel": "example-string",
          "volumePricingEnabled": true,
          "volumeTiers": []
        },
        "requireSelection": true,
        "startExpanded": true,
        "tags": [
          "example-string"
        ],
        "updated_at": "example-string"
      }
    ],
    "content": "example-string",
    "designSettings": {
      "backgroundAttachment": "example-string",
      "backgroundColor": "example-string",
      "backgroundImage": "example-string",
      "backgroundOpacity": 100,
      "backgroundPosition": "example-string",
      "backgroundRepeat": "example-string",
      "backgroundSize": "example-string",
      "contentAlign": "left",
      "contentWidth": "full",
      "fontColor": "example-string"
    },
    "discounts": [
      {
        "amount": "example-string",
        "frequency": "example-string",
        "id": "example-string",
        "type": "fixed"
      }
    ],
    "displayHeading": true,
    "excludeFromPdf": true,
    "hideSection": true,
    "hideTotalsBottom": true,
    "hideTotalsTop": true,
    "isScopeOfWork": true,
    "isSignaturesPage": true,
    "kind": "example-string",
    "labels": {
      "outOfPocket": "example-string",
      "tax": "example-string"
    },
    "lineItemsStartExpanded": "none",
    "markupPercentage": "example-string",
    "order_key": 100,
    "requireSelection": true,
    "salesTaxPercentage": "example-string",
    "scopeId": "example-string",
    "screenshotUrl": "example-string",
    "selectionType": "single",
    "showCents": true,
    "startNewPdfPage": true,
    "tags": [
      "example-string"
    ],
    "useRoundedAmounts": true
  },
  "in_library": true,
  "parent_proposal": "zw5FD5HGcfE3"
}

Responses

201Page created. data.id is the new page's Public ID.

dataProposalPage

childrenarray of PageChild

Unified ordered list of groups and side-by-sides (only on scope-of-work pages)

contentstring

Rich text content of the page

created_atstring

When the page was created (ISO 8601 timestamp)

designSettingsPageDesignSettings

discountsarray of object

Discount configurations for this page

displayHeadingboolean

Whether to display the page heading

excludeFromPdfboolean

Whether to exclude this page from PDF exports

hideSectionboolean

Hide this page from recipients (the editor "Hide this Page" toggle). Staff still see it in the proposal editor. Recipients do not see it on the public view, preview, sign, or default PDF. Hidden Scope of Work pages are left out of grand totals. This is not ArchivePage and not excludeFromPdf. Set false to show the page again.

hideTotalsBottomboolean

Whether to hide the totals row at the bottom of the page

hideTotalsTopboolean

Whether to hide the totals row at the top of the page

idstring

Unique page identifier

isScopeOfWorkboolean

Whether this page is a scope of work pricing page

isSignaturesPageboolean

Whether this is the signatures page

kindstring

Type of page (e.g., content, pricing, signatures)

labelsobject

Custom label overrides for this page

lineItemsStartExpandedenum

Whether line items are expanded by default

noneallfirst

markupPercentagestring

Markup percentage applied to items on this page

metadataRecord%3Cstring%2Cunknown%3E

namestring

Page name/title

order_keynumber

Sort position of the page within the proposal

requireSelectionboolean

When selectionType is loose, require the customer to select at least one optional group

salesTaxPercentagestring

Sales tax percentage applied to this page

scopeIdstring

ID of the scope of work section this page belongs to

screenshotUrlnullable string

URL of the page screenshot thumbnail

selectionTypeenum

How items on this page can be selected

singlemultipleloose

showCentsboolean

Whether to display cents in price values

startNewPdfPageboolean

When false, this page continues on the same PDF page as the previous one. Omitted/undefined keeps the historical behavior: each page starts a new PDF page.

tagsarray of string

Tags/labels applied to this page

updated_atstring

When the page was last updated (ISO 8601 timestamp)

useRoundedAmountsboolean

Use rounded whole-dollar line amounts in the price math. Only applies while showCents is off. Missing means off. Set from the account default when the proposal or template is created, or copied from the template a proposal is based on.

Example

{
  "data": {
    "content": "example-string",
    "name": "example-string",
    "order_key": 100,
    "children": [
      {
        "displayCost": "show_all",
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "kind": "group",
        "lineItems": [
          {
            "children": [],
            "description": "example-string",
            "discountExempt": true,
            "id": "example-string",
            "isOptional": true,
            "isSelected": true,
            "markupExempt": true,
            "name": "example-string",
            "taxExempt": true,
            "archived_at": "example-string",
            "childCount": 100,
            "created_at": "example-string",
            "externalItemId": "example-string",
            "hasLinkedItems": true,
            "hidden": true,
            "hideModifications": true,
            "in_library": true,
            "integrations": {},
            "internalNotes": "example-string",
            "is_archived": true,
            "label": "example-string",
            "linkedLibraryItemId": "example-string",
            "locked": true,
            "modificationsLabel": "example-string",
            "order_key": 100,
            "parent_id": "example-string",
            "requireSelection": true,
            "selectionType": "single",
            "showCents": true,
            "skipRounding": true,
            "startExpanded": true,
            "tags": [],
            "terms": "example-string",
            "updated_at": "example-string"
          }
        ],
        "name": "example-string",
        "selectionType": "single",
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "hidden": true,
        "hideQuantities": true,
        "in_library": true,
        "internalNotes": "example-string",
        "is_archived": true,
        "linkedScopeId": "example-string",
        "locked": true,
        "order_key": 100,
        "pdfPageBreak": true,
        "quantity": {
          "editableByRecipient": true,
          "max": 100,
          "min": 100,
          "current": 100,
          "unitLabel": "example-string",
          "volumePricingEnabled": true,
          "volumeTiers": []
        },
        "requireSelection": true,
        "startExpanded": true,
        "tags": [
          "example-string"
        ],
        "updated_at": "example-string"
      }
    ],
    "created_at": "example-string",
    "designSettings": {
      "backgroundAttachment": "example-string",
      "backgroundColor": "example-string",
      "backgroundImage": "example-string",
      "backgroundOpacity": 100,
      "backgroundPosition": "example-string",
      "backgroundRepeat": "example-string",
      "backgroundSize": "example-string",
      "contentAlign": "left",
      "contentWidth": "full",
      "fontColor": "example-string"
    },
    "discounts": [
      {
        "amount": "example-string",
        "frequency": "example-string",
        "id": "example-string",
        "type": "fixed"
      }
    ],
    "displayHeading": true,
    "excludeFromPdf": true,
    "hideSection": true,
    "hideTotalsBottom": true,
    "hideTotalsTop": true,
    "id": "example-string",
    "isScopeOfWork": true,
    "isSignaturesPage": true,
    "kind": "example-string",
    "labels": {
      "outOfPocket": "example-string",
      "tax": "example-string"
    },
    "lineItemsStartExpanded": "none",
    "markupPercentage": "example-string",
    "requireSelection": true,
    "salesTaxPercentage": "example-string",
    "scopeId": "example-string",
    "screenshotUrl": "example-string",
    "selectionType": "single",
    "showCents": true,
    "startNewPdfPage": true,
    "tags": [
      "example-string"
    ],
    "updated_at": "example-string",
    "useRoundedAmounts": true
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal or organization not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version), or a library page with this name already exists (only when in_library is true).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/pages/{id}

GetPage

Return one page with its title (name), HTML body (content), and settings. hideSection is true when the page is hidden from recipients (the editor "Hide this Page" toggle). isScopeOfWork is true for a pricing page. The groups and side-by-sides on a Scope of Work page are not included; read them with ListGroups or GetProposal. The page object is returned at the top level, with no "data" wrapper.

Path Parameters

idstringrequired

Public ID of the page, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

200The page.

ProposalPage

childrenarray of PageChild

Unified ordered list of groups and side-by-sides (only on scope-of-work pages)

contentstring

Rich text content of the page

created_atstring

When the page was created (ISO 8601 timestamp)

designSettingsPageDesignSettings

discountsarray of object

Discount configurations for this page

displayHeadingboolean

Whether to display the page heading

excludeFromPdfboolean

Whether to exclude this page from PDF exports

hideSectionboolean

hideTotalsBottomboolean

Whether to hide the totals row at the bottom of the page

hideTotalsTopboolean

Whether to hide the totals row at the top of the page

idstring

Unique page identifier

isScopeOfWorkboolean

Whether this page is a scope of work pricing page

isSignaturesPageboolean

Whether this is the signatures page

kindstring

Type of page (e.g., content, pricing, signatures)

labelsobject

Custom label overrides for this page

lineItemsStartExpandedenum

Whether line items are expanded by default

noneallfirst

markupPercentagestring

Markup percentage applied to items on this page

metadataRecord%3Cstring%2Cunknown%3E

namestring

Page name/title

order_keynumber

Sort position of the page within the proposal

requireSelectionboolean

When selectionType is loose, require the customer to select at least one optional group

salesTaxPercentagestring

Sales tax percentage applied to this page

scopeIdstring

ID of the scope of work section this page belongs to

screenshotUrlnullable string

URL of the page screenshot thumbnail

selectionTypeenum

How items on this page can be selected

singlemultipleloose

showCentsboolean

Whether to display cents in price values

startNewPdfPageboolean

When false, this page continues on the same PDF page as the previous one. Omitted/undefined keeps the historical behavior: each page starts a new PDF page.

tagsarray of string

Tags/labels applied to this page

updated_atstring

When the page was last updated (ISO 8601 timestamp)

useRoundedAmountsboolean

Example

{
  "content": "example-string",
  "name": "example-string",
  "order_key": 100,
  "children": [
    {
      "displayCost": "show_all",
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "kind": "group",
      "lineItems": [
        {
          "children": [],
          "description": "example-string",
          "discountExempt": true,
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "markupExempt": true,
          "name": "example-string",
          "taxExempt": true,
          "archived_at": "example-string",
          "childCount": 100,
          "created_at": "example-string",
          "externalItemId": "example-string",
          "hasLinkedItems": true,
          "hidden": true,
          "hideModifications": true,
          "in_library": true,
          "integrations": {
            "quickbooks": {}
          },
          "internalNotes": "example-string",
          "is_archived": true,
          "label": "example-string",
          "linkedLibraryItemId": "example-string",
          "locked": true,
          "modificationsLabel": "example-string",
          "order_key": 100,
          "parent_id": "example-string",
          "requireSelection": true,
          "selectionType": "single",
          "showCents": true,
          "skipRounding": true,
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "terms": "example-string",
          "updated_at": "example-string"
        }
      ],
      "name": "example-string",
      "selectionType": "single",
      "archived_at": "example-string",
      "created_at": "example-string",
      "description": "example-string",
      "hidden": true,
      "hideQuantities": true,
      "in_library": true,
      "internalNotes": "example-string",
      "is_archived": true,
      "linkedScopeId": "example-string",
      "locked": true,
      "order_key": 100,
      "pdfPageBreak": true,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "unitLabel": "example-string",
        "volumePricingEnabled": true,
        "volumeTiers": [
          {}
        ]
      },
      "requireSelection": true,
      "startExpanded": true,
      "tags": [
        "example-string"
      ],
      "updated_at": "example-string"
    }
  ],
  "created_at": "example-string",
  "designSettings": {
    "backgroundAttachment": "example-string",
    "backgroundColor": "example-string",
    "backgroundImage": "example-string",
    "backgroundOpacity": 100,
    "backgroundPosition": "example-string",
    "backgroundRepeat": "example-string",
    "backgroundSize": "example-string",
    "contentAlign": "left",
    "contentWidth": "full",
    "fontColor": "example-string"
  },
  "discounts": [
    {
      "amount": "example-string",
      "frequency": "example-string",
      "id": "example-string",
      "type": "fixed"
    }
  ],
  "displayHeading": true,
  "excludeFromPdf": true,
  "hideSection": true,
  "hideTotalsBottom": true,
  "hideTotalsTop": true,
  "id": "example-string",
  "isScopeOfWork": true,
  "isSignaturesPage": true,
  "kind": "example-string",
  "labels": {
    "outOfPocket": "example-string",
    "tax": "example-string"
  },
  "lineItemsStartExpanded": "none",
  "markupPercentage": "example-string",
  "requireSelection": true,
  "salesTaxPercentage": "example-string",
  "scopeId": "example-string",
  "screenshotUrl": "example-string",
  "selectionType": "single",
  "showCents": true,
  "startNewPdfPage": true,
  "tags": [
    "example-string"
  ],
  "updated_at": "example-string",
  "useRoundedAmounts": true
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Page not found.

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/pages/{id}

UpdatePage

Change a page's title, HTML body, or settings. Only the fields you send change. The body is flat, with no "page" wrapper. name is the page title and content is the HTML body. Example: { "name": "Our Approach", "content": "We start with discovery." }. To hide a page from recipients (the editor "Hide this Page" toggle), send hideSection: true. Staff still see the page in the editor; recipients do not, and hidden Scope of Work pages are left out of grand totals. This is not ArchivePage. Send hideSection: false to show the page again. excludeFromPdf only affects PDF exports. On a Scope of Work page you can also change pricing-table settings such as selectionType, requireSelection, showCents, useRoundedAmounts, hideTotalsTop, hideTotalsBottom, salesTaxPercentage, markupPercentage, and discounts. Groups, side-by-sides, and line items on the page are not edited here; children in the body is ignored. Use UpdateGroup, UpdateItem, and UpdateModification for those. To change a line item's price, use PATCH /api/items/{id}. Proposals that are pending signature, won, or lost cannot be edited (409 PROPOSAL_LOCKED), and neither can a locked customer version.

Path Parameters

idstringrequired

Public ID of the page, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

designSettingsnullable PageDesignSettings

namestring

Page name/title

contentstring

Rich text content of the page

order_keynumber

Sort position of the page within the proposal

kindstring

Type of page (e.g., content, pricing, signatures)

scopeIdstring

ID of the scope of work section this page belongs to

isScopeOfWorkboolean

Whether this page is a scope of work pricing page

isSignaturesPageboolean

Whether this is the signatures page

screenshotUrlnullable string

URL of the page screenshot thumbnail

showCentsboolean

Whether to display cents in price values

useRoundedAmountsboolean

salesTaxPercentagestring

Sales tax percentage applied to this page

lineItemsStartExpandedenum

Whether line items are expanded by default

noneallfirst

selectionTypeenum

How items on this page can be selected

singlemultipleloose

requireSelectionboolean

When selectionType is loose, require the customer to select at least one optional group

tagsarray of string

Tags/labels applied to this page

metadataRecord%3Cstring%2Cunknown%3E

markupPercentagestring

Markup percentage applied to items on this page

discountsarray of object

Discount configurations for this page

hideTotalsTopboolean

Whether to hide the totals row at the top of the page

hideTotalsBottomboolean

Whether to hide the totals row at the bottom of the page

labelsobject

Custom label overrides for this page

displayHeadingboolean

Whether to display the page heading

hideSectionboolean

excludeFromPdfboolean

Whether to exclude this page from PDF exports

startNewPdfPageboolean

When false, this page continues on the same PDF page as the previous one. Omitted/undefined keeps the historical behavior: each page starts a new PDF page.

childrenarray of PageChild

Unified ordered list of groups and side-by-sides (only on scope-of-work pages)

Example

{
  "children": [
    {
      "displayCost": "show_all",
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "kind": "group",
      "lineItems": [
        {
          "children": [],
          "description": "example-string",
          "discountExempt": true,
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "markupExempt": true,
          "name": "example-string",
          "taxExempt": true,
          "archived_at": "example-string",
          "childCount": 100,
          "created_at": "example-string",
          "externalItemId": "example-string",
          "hasLinkedItems": true,
          "hidden": true,
          "hideModifications": true,
          "in_library": true,
          "integrations": {
            "quickbooks": {}
          },
          "internalNotes": "example-string",
          "is_archived": true,
          "label": "example-string",
          "linkedLibraryItemId": "example-string",
          "locked": true,
          "modificationsLabel": "example-string",
          "order_key": 100,
          "parent_id": "example-string",
          "requireSelection": true,
          "selectionType": "single",
          "showCents": true,
          "skipRounding": true,
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "terms": "example-string",
          "updated_at": "example-string"
        }
      ],
      "name": "example-string",
      "selectionType": "single",
      "archived_at": "example-string",
      "created_at": "example-string",
      "description": "example-string",
      "hidden": true,
      "hideQuantities": true,
      "in_library": true,
      "internalNotes": "example-string",
      "is_archived": true,
      "linkedScopeId": "example-string",
      "locked": true,
      "order_key": 100,
      "pdfPageBreak": true,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "unitLabel": "example-string",
        "volumePricingEnabled": true,
        "volumeTiers": [
          {}
        ]
      },
      "requireSelection": true,
      "startExpanded": true,
      "tags": [
        "example-string"
      ],
      "updated_at": "example-string"
    }
  ],
  "content": "example-string",
  "designSettings": {
    "backgroundAttachment": "example-string",
    "backgroundColor": "example-string",
    "backgroundImage": "example-string",
    "backgroundOpacity": 100,
    "backgroundPosition": "example-string",
    "backgroundRepeat": "example-string",
    "backgroundSize": "example-string",
    "contentAlign": "left",
    "contentWidth": "full",
    "fontColor": "example-string"
  },
  "discounts": [
    {
      "amount": "example-string",
      "frequency": "example-string",
      "id": "example-string",
      "type": "fixed"
    }
  ],
  "displayHeading": true,
  "excludeFromPdf": true,
  "hideSection": true,
  "hideTotalsBottom": true,
  "hideTotalsTop": true,
  "isScopeOfWork": true,
  "isSignaturesPage": true,
  "kind": "example-string",
  "labels": {
    "outOfPocket": "example-string",
    "tax": "example-string"
  },
  "lineItemsStartExpanded": "none",
  "markupPercentage": "example-string",
  "name": "example-string",
  "order_key": 100,
  "requireSelection": true,
  "salesTaxPercentage": "example-string",
  "scopeId": "example-string",
  "screenshotUrl": "example-string",
  "selectionType": "single",
  "showCents": true,
  "startNewPdfPage": true,
  "tags": [
    "example-string"
  ],
  "useRoundedAmounts": true
}

Responses

200Page updated. data.id is the page's Public ID; settings are returned inside data.attrs.

dataobject

attrsobject

Stored page settings.

created_atstring

idstring

Public ID of the page.

kindstring

namestring

Page title.

order_keynumber

proposal_idstring

Public ID of the proposal.

updated_atstring

Example

{
  "data": {
    "attrs": {},
    "created_at": "2024-01-20T15:30:00Z",
    "id": "zw5FD5HGcfE3",
    "kind": "page",
    "name": "example-string",
    "order_key": 100,
    "proposal_id": "example-string",
    "updated_at": "2024-01-20T15:30:00Z"
  }
}

400Validation error.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Page not found.

409The proposal is locked (PROPOSAL_LOCKED: pending signature, won, lost, or a locked customer version), or a library page with this name already exists (DUPLICATE_NAME).

errorobject

Example

{
  "error": {
    "code": "DUPLICATE_NAME",
    "existingPageId": "example-string",
    "message": "A page with the name \"Page Name\" already exists in the library."
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/pages/{id}

DeletePage

Delete a page. It is soft-deleted: it disappears from the proposal and from API responses. Deleting a Scope of Work page also deletes its groups, side-by-sides, and line items. To remove a page but keep the option to bring it back, use ArchivePage and UnarchivePage instead. Requires permission to delete proposals.

Path Parameters

idstringrequired

Public ID of the page, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

204Page deleted. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to delete from this proposal.

404Page not found.

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/pages/{id}/archive

ArchivePage

Remove a page from the proposal in a way you can undo. The archived page is hidden from the proposal and left out of default list responses. Archiving a Scope of Work page recalculates the proposal totals. Bring it back with UnarchivePage. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the page, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

204Page archived. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Page not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/pages/{id}/duplicate

DuplicatePage

Copy a page. With an empty body, the copy is placed directly below the original in the same proposal and named "Copy of <original name>". For a Scope of Work page this is a deep copy: its groups, line items, modifications, and side-by-sides are copied too. Other modes, chosen by the body: toLibrary=true saves the page to the content library (with optional tags). toProposal (a proposal Public ID) adds a library page to that proposal; add fromProposal=true to copy a page from another proposal instead (signature pages cannot be copied this way). toPage (a page Public ID) overwrites that page with this page's content. Proposals that are pending signature, won, or lost cannot be edited (409). Copying from another proposal into one of those proposals returns 400.

Path Parameters

idstringrequired

Public ID of the page to copy, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

namestring

Name for the copy. Defaults to "Copy of <original name>".

toLibraryboolean

Save the page to the content library instead of copying it within the proposal.

tagsarray of string

Library tags to apply when toLibrary is true.

toPagestring

Public ID of a page to overwrite with this page's content.

toProposalstring

Public ID of the proposal to copy the page into.

fromProposalboolean

Set to true with toProposal when the source page is in a proposal rather than the library.

sourceProposalNamestring

Name of the source proposal, used in the activity log.

order_keynumber

Position of the copy in the destination proposal (used with toProposal).

sourceOrgIdstring

Only for pages from the shared template library. Leave unset for your own library.

attrsobject

Design settings to store with the page when saving to the library.

Example

{
  "attrs": {},
  "fromProposal": true,
  "name": "Terms and Conditions (2026)",
  "order_key": 100,
  "sourceOrgId": "example-string",
  "sourceProposalName": "example-string",
  "tags": [
    "example-string"
  ],
  "toLibrary": true,
  "toPage": "example-string",
  "toProposal": "zw5FD5HGcfE3"
}

Responses

200Target page overwritten (when toPage is set).

201Page copied. Returns the new page.

400Invalid request, a signature page was sent with fromProposal, or the destination proposal is pending signature, won, or lost.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403You do not have permission to edit the source or destination.

404Page or proposal not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/pages/{id}/move

MovePage

Change a page's position in its proposal. Send after_id as the Public ID of the page it should follow, or null (or the proposal's Public ID) to move it to the top. You can send order_key instead to set an exact position. The page's content and, for a Scope of Work page, its pricing move with it. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the page to move, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

order_keynumber

New explicit order position within the proposal.

after_idstring

Public ID of the page this page should come immediately after. Pass null, an empty string, or the proposal's id to move it to the very top. The server computes the order_key.

Example

{
  "after_id": "zw5FD5HGcfE3",
  "order_key": 3
}

Responses

200Page moved successfully

dataobject

idstring

Public ID of the moved page.

order_keynumber

New order position

Example

{
  "data": {
    "id": "zw5FD5HGcfE3",
    "order_key": 100
  }
}

400Neither order_key nor after_id was sent.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Page not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/pages/{id}/unarchive

UnarchivePage

Restore an archived page so it shows in the proposal again. For a Scope of Work page, its groups, side-by-sides, and line items are restored too, and the proposal totals are recalculated. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the archived page, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

204Page restored. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Page not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}/pages

ListPages

Return a proposal's pages in order, with each page's Public ID, title (name), HTML body (content), and settings. isScopeOfWork is true for pricing pages. Use a returned id with GetPage, UpdatePage, or as scope_of_work_page_id when adding groups and side-by-sides.

Path Parameters

idstringrequired

Public ID of the proposal (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Query Parameters

limitinteger

Default: 50. Number of pages to return (max 100).

offsetinteger

Default: 0. Number of pages to skip.

orderenum

ascdefaultdesc

Sort order

searchstring

Search term to filter pages by name or content

sortenum

order_keydefaultnamecreated_atupdated_at

Field to sort by

Responses

200Successful response with pages list

dataarray of ProposalPage

childrenarray of PageChild

Unified ordered list of groups and side-by-sides (only on scope-of-work pages)

contentstring

Rich text content of the page

created_atstring

When the page was created (ISO 8601 timestamp)

designSettingsPageDesignSettings

discountsarray of object

Discount configurations for this page

displayHeadingboolean

Whether to display the page heading

excludeFromPdfboolean

Whether to exclude this page from PDF exports

hideSectionboolean

hideTotalsBottomboolean

Whether to hide the totals row at the bottom of the page

hideTotalsTopboolean

Whether to hide the totals row at the top of the page

idstring

Unique page identifier

isScopeOfWorkboolean

Whether this page is a scope of work pricing page

isSignaturesPageboolean

Whether this is the signatures page

kindstring

Type of page (e.g., content, pricing, signatures)

labelsobject

Custom label overrides for this page

lineItemsStartExpandedenum

Whether line items are expanded by default

noneallfirst

markupPercentagestring

Markup percentage applied to items on this page

metadataRecord%3Cstring%2Cunknown%3E

namestring

Page name/title

order_keynumber

Sort position of the page within the proposal

requireSelectionboolean

When selectionType is loose, require the customer to select at least one optional group

salesTaxPercentagestring

Sales tax percentage applied to this page

scopeIdstring

ID of the scope of work section this page belongs to

screenshotUrlnullable string

URL of the page screenshot thumbnail

selectionTypeenum

How items on this page can be selected

singlemultipleloose

showCentsboolean

Whether to display cents in price values

startNewPdfPageboolean

When false, this page continues on the same PDF page as the previous one. Omitted/undefined keeps the historical behavior: each page starts a new PDF page.

tagsarray of string

Tags/labels applied to this page

updated_atstring

When the page was last updated (ISO 8601 timestamp)

useRoundedAmountsboolean

paginationobject

Example

{
  "data": [
    {
      "content": "example-string",
      "name": "example-string",
      "order_key": 100,
      "children": [
        {
          "displayCost": "show_all",
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "kind": "group",
          "lineItems": [
            {}
          ],
          "name": "example-string",
          "selectionType": "single",
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "hidden": true,
          "hideQuantities": true,
          "in_library": true,
          "internalNotes": "example-string",
          "is_archived": true,
          "linkedScopeId": "example-string",
          "locked": true,
          "order_key": 100,
          "pdfPageBreak": true,
          "quantity": {
            "editableByRecipient": true,
            "max": 100,
            "min": 100,
            "current": 100,
            "volumePricingEnabled": true,
            "volumeTiers": []
          },
          "requireSelection": true,
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "updated_at": "example-string"
        }
      ],
      "created_at": "example-string",
      "designSettings": {
        "backgroundAttachment": "example-string",
        "backgroundColor": "example-string",
        "backgroundImage": "example-string",
        "backgroundOpacity": 100,
        "backgroundPosition": "example-string",
        "backgroundRepeat": "example-string",
        "backgroundSize": "example-string",
        "contentAlign": "left",
        "contentWidth": "full",
        "fontColor": "example-string"
      },
      "discounts": [
        {
          "amount": "example-string",
          "frequency": "example-string",
          "id": "example-string",
          "type": "fixed"
        }
      ],
      "displayHeading": true,
      "excludeFromPdf": true,
      "hideSection": true,
      "hideTotalsBottom": true,
      "hideTotalsTop": true,
      "id": "example-string",
      "isScopeOfWork": true,
      "isSignaturesPage": true,
      "kind": "example-string",
      "labels": {
        "outOfPocket": "example-string",
        "tax": "example-string"
      },
      "lineItemsStartExpanded": "none",
      "markupPercentage": "example-string",
      "requireSelection": true,
      "salesTaxPercentage": "example-string",
      "scopeId": "example-string",
      "screenshotUrl": "example-string",
      "selectionType": "single",
      "showCents": true,
      "startNewPdfPage": true,
      "tags": [
        "example-string"
      ],
      "updated_at": "example-string",
      "useRoundedAmounts": true
    }
  ],
  "pagination": {}
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/pages/reorder

ReorderPages

Set the order of a proposal's pages. Send page_ids as the Public IDs of the pages in the order you want; the first id is shown first. Include every page. Pages you leave out are placed after the listed pages, sorted alphabetically by name. Every id must be a page in this proposal, otherwise the request fails with 400. To move one page, use MovePage. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the proposal (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

page_idsarray of stringrequired

Public IDs of all pages in this proposal, in the desired order. Must not be empty.

Example

{
  "page_ids": [
    "qeP5CKvwBveC",
    "N66wN1Yhese9",
    "Vv5EYHv5aNEx"
  ]
}

Responses

200Pages reordered successfully

messagestring

updated_pagesarray of object

Example

{
  "message": "Pages reordered successfully",
  "updated_pages": [
    {
      "id": "example-string",
      "name": "example-string",
      "order_key": 100
    }
  ]
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

Groups(11)

POST/groups

CreateGroup

Create an empty group (a set of line items shown together in a pricing table). Send exactly one parent: - parent_proposal: Public ID of a proposal. The group goes on the proposal's first Scope of Work page. - parent_page: Public ID of a Scope of Work page. - in_library: true saves the group to your organization's library. The group's fields go inside "group"; only group.name is required. The new group is added at the end of the page. Example: { "parent_proposal": "zw5FD5HGcfE3", "group": { "name": "Phase 1", "isOptional": false } }. A group has no price of its own. Add line items with CreateItem (parent_group set to the returned id) or with POST /api/proposals/{id}/items (type line_item, target_group_id). To place a group next to an existing one, POST /api/proposals/{id}/items with type group is usually simpler. Proposals that are pending signature, won, or lost cannot be edited (409).

Request Body

groupobjectrequired

parent_proposalstring

Public ID of the proposal. The group is added to its first Scope of Work page.

parent_pagestring

Public ID of a Scope of Work page to add the group to.

in_libraryboolean

Create the group in your organization's library.

Example

{
  "group": {
    "name": "example-string",
    "description": "example-string",
    "displayCost": "show_all",
    "hidden": true,
    "hideQuantities": true,
    "in_library": true,
    "internalNotes": "example-string",
    "isOptional": true,
    "isSelected": true,
    "kind": "group",
    "locked": true,
    "order_key": 100,
    "pdfPageBreak": true,
    "quantity": {
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "current": 100,
      "unitLabel": "example-string",
      "volumePricingEnabled": true,
      "volumeTiers": [
        {
          "unitPrice": 100,
          "upTo": 100
        }
      ]
    },
    "requireSelection": true,
    "selectionType": "single",
    "startExpanded": true,
    "tags": [
      "example-string"
    ]
  },
  "in_library": true,
  "parent_page": "example-string",
  "parent_proposal": "zw5FD5HGcfE3"
}

Responses

201Group created.

dataobject

idstring

Public ID of the new group.

kindstring

namestring

Group name.

parent_idstring

Public ID of the Scope of Work page the group is on (null for library groups).

Example

{
  "data": {
    "id": "zw5FD5HGcfE3",
    "kind": "group",
    "name": "example-string",
    "parent_id": "example-string"
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal, Scope of Work page, or organization not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version), or a library group with this name already exists (only when in_library is true).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/groups/{id}

GetGroup

Return one group with its settings and its line items. Each line item includes its Public ID, its price, and its modifications (children). For fixed prices, price.value is in dollars, not cents. Use the line item and modification ids with UpdateItem and UpdateModification to change prices.

Path Parameters

idstringrequired

Public ID of the group, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

200The group, including lineItems.

dataobject

archived_atnullable string

When the group was archived (ISO 8601 timestamp), or null if active

created_atstring

When the group was created (ISO 8601 timestamp)

descriptionstring

Group description text

displayCostenum

Whether to show the cost for this group

show_allhide_allhide_item_costshide_group_cost

hiddenboolean

Hidden from the client (same meaning as line-item hidden)

hideQuantitiesboolean

Whether to hide quantity columns

idstring

Unique group identifier

in_libraryboolean

Whether this group belongs to the library (true) or a regular proposal (false/undefined)

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

is_archivedboolean

Whether the group is archived

isOptionalboolean

Whether this group is optional for the client

isSelectedboolean

Whether this optional group is currently selected

kindstring

Discriminator for PageChild union (set when part of children array)

lineItemsarray of LineItem

Array of line items in this group

linkedScopeIdnullable string

ID of the linked scope of work section

lockedboolean

Logic lock — not in totals, not writable

metadataRecord%3Cstring%2Cunknown%3E

namestring

Group name/title

order_keynumber

Sort position of the group within the page

pdfPageBreakboolean

When generating a PDF, start this group at the top of a new page

quantityQuantityConfig

requireSelectionboolean

When selectionType is loose, require the customer to select at least one optional line item

selectionTypeenum

How items within this group can be selected (single, multiple, etc.)

singlemultipleloose

startExpandedboolean

Whether the group starts expanded in the proposal view

tagsarray of string

Tags/labels applied to this group

updated_atstring

When the group was last updated (ISO 8601 timestamp)

Example

{
  "data": {
    "displayCost": "show_all",
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "lineItems": [
      {
        "children": [
          {
            "discountExempt": true,
            "id": "example-string",
            "isOptional": true,
            "isSelected": true,
            "markupExempt": true,
            "name": "example-string",
            "taxExempt": true,
            "archived_at": "example-string",
            "created_at": "example-string",
            "description": "example-string",
            "externalItemId": "example-string",
            "hidden": true,
            "integrations": {
              "quickbooks": {}
            },
            "internalNotes": "example-string",
            "is_archived": true,
            "kind": "mod",
            "label": "example-string",
            "locked": true,
            "requireSelection": true,
            "selectionType": "single",
            "showCents": true,
            "skipRounding": true,
            "terms": "example-string",
            "updated_at": "example-string"
          }
        ],
        "description": "example-string",
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "childCount": 100,
        "created_at": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hasLinkedItems": true,
        "hidden": true,
        "hideModifications": true,
        "in_library": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "label": "example-string",
        "linkedLibraryItemId": "example-string",
        "locked": true,
        "modificationsLabel": "example-string",
        "order_key": 100,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "parent_id": "example-string",
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "startExpanded": true,
        "tags": [
          "example-string"
        ],
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "name": "example-string",
    "selectionType": "single",
    "archived_at": "example-string",
    "created_at": "example-string",
    "description": "example-string",
    "hidden": true,
    "hideQuantities": true,
    "in_library": true,
    "internalNotes": "example-string",
    "is_archived": true,
    "kind": "group",
    "linkedScopeId": "example-string",
    "locked": true,
    "order_key": 100,
    "pdfPageBreak": true,
    "quantity": {
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "current": 100,
      "unitLabel": "example-string",
      "volumePricingEnabled": true,
      "volumeTiers": [
        {
          "unitPrice": 100,
          "upTo": 100
        }
      ]
    },
    "requireSelection": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "updated_at": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Group not found.

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/groups/{id}

UpdateGroup

Change a group's name, description, or settings. Only the fields you send change. The body is flat, with no "group" wrapper. Example: { "name": "Phase 2", "isOptional": true, "selectionType": "single" }. A group has no price of its own; its total comes from its line items. To change a line item's price, use UpdateItem (PATCH /api/items/{id}). quantity sets a group-level multiplier applied to the group's line items. Proposals that are pending signature, won, or lost cannot be edited (409 PROPOSAL_LOCKED), and neither can a locked customer version.

Path Parameters

idstringrequired

Public ID of the group, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

kindstring

Discriminator for PageChild union (set when part of children array)

namestring

Group name/title

descriptionstring

Group description text

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

isOptionalboolean

Whether this group is optional for the client

isSelectedboolean

Whether this optional group is currently selected

hiddenboolean

Hidden from the client (same meaning as line-item hidden)

lockedboolean

Logic lock — not in totals, not writable

displayCostenum

Whether to show the cost for this group

show_allhide_allhide_item_costshide_group_cost

selectionTypeenum

How items within this group can be selected (single, multiple, etc.)

singlemultipleloose

requireSelectionboolean

When selectionType is loose, require the customer to select at least one optional line item

hideQuantitiesboolean

Whether to hide quantity columns

startExpandedboolean

Whether the group starts expanded in the proposal view

pdfPageBreakboolean

When generating a PDF, start this group at the top of a new page

quantityQuantityConfig

order_keynumber

Sort position of the group within the page

tagsarray of string

Tags/labels applied to this group

metadataRecord%3Cstring%2Cunknown%3E

in_libraryboolean

Whether this group belongs to the library (true) or a regular proposal (false/undefined)

Example

{
  "description": "example-string",
  "displayCost": "show_all",
  "hidden": true,
  "hideQuantities": true,
  "in_library": true,
  "internalNotes": "example-string",
  "isOptional": true,
  "isSelected": true,
  "kind": "group",
  "locked": true,
  "name": "example-string",
  "order_key": 100,
  "pdfPageBreak": true,
  "quantity": {
    "editableByRecipient": true,
    "max": 100,
    "min": 100,
    "current": 100,
    "unitLabel": "example-string",
    "volumePricingEnabled": true,
    "volumeTiers": [
      {
        "unitPrice": 100,
        "upTo": 100
      }
    ]
  },
  "requireSelection": true,
  "selectionType": "single",
  "startExpanded": true,
  "tags": [
    "example-string"
  ]
}

Responses

200Group updated. data.id is the group's Public ID. Settings such as selectionType and displayCost are returned inside data.attrs.

dataobject

attrsobject

Stored group settings.

created_atstring

idstring

Public ID of the group.

kindstring

namestring

optionalboolean

order_keynumber

selectedboolean

updated_atstring

Example

{
  "data": {
    "attrs": {},
    "created_at": "2024-01-20T15:30:00Z",
    "id": "zw5FD5HGcfE3",
    "kind": "group",
    "name": "example-string",
    "optional": true,
    "order_key": 100,
    "selected": true,
    "updated_at": "2024-01-20T15:30:00Z"
  }
}

400Validation error (for example an empty name or an invalid selectionType).

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Group not found.

409The proposal is locked (PROPOSAL_LOCKED: pending signature, won, lost, or a locked customer version), or a library group with this name already exists (DUPLICATE_NAME).

errorobject

Example

{
  "error": {
    "code": "DUPLICATE_NAME",
    "existingGroupId": "example-string",
    "message": "A group with the name \"Group Name\" already exists in the library."
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/groups/{id}

DeleteGroup

Delete a group and every line item in it. They are soft-deleted: they disappear from the proposal and from API responses, and the proposal totals are recalculated. To remove a group but keep the option to bring it back, use ArchiveGroup and UnarchiveGroup instead. Requires permission to delete proposals.

Path Parameters

idstringrequired

Public ID of the group, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

204Group deleted. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to delete from this proposal.

404Group not found.

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/groups/{id}/archive

ArchiveGroup

Remove a group from the proposal in a way you can undo. The archived group, and the line items shown inside it, are hidden from the proposal and left out of default list responses. Bring it back with UnarchiveGroup. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the group, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

204Group archived. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Group not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/groups/{id}/duplicate

DuplicateGroup

Copy a group with its settings, line items, and their modifications. Prices are copied as they are. With an empty body the copy goes on the same Scope of Work page, named "<original name> - Copy". To copy into another proposal, send proposalId (Public ID of the destination proposal) and parent_item_id (Public ID of a Scope of Work page in that proposal). A copy into another proposal keeps the original name unless you send name. The destination cannot be pending signature, won, or lost. Other modes: toLibrary true saves the group to your library, and toGroup overwrites an existing group with this group's content.

Path Parameters

idstringrequired

Public ID of the group to copy, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

namestring

Name for the copy. Default is the original name plus " - Copy" in the same proposal, or the original name when copying into another proposal.

includeItemsboolean

Also copy the group's line items and their modifications.

orderKeynumber

Position for the copy on the page. Optional.

proposalIdstring

Public ID of the destination proposal, to copy into another proposal.

parent_item_idstring

Public ID of the destination Scope of Work page. Required with proposalId.

toLibraryboolean

Save a copy to your organization's library instead.

tagsarray of string

With toLibrary. Tags for the library copy.

selectionTypeenum

With toLibrary. Selection type for the library copy.

singlemultipleloose

toGroupstring

Public ID of an existing group to overwrite with this group's content (the "update from" action). No new group is created.

Example

{
  "includeItems": true,
  "name": "Website Development - Copy",
  "orderKey": 1.5,
  "parent_item_id": "example-string",
  "proposalId": "example-string",
  "selectionType": "single",
  "tags": [
    "example-string"
  ],
  "toGroup": "example-string",
  "toLibrary": true
}

Responses

200Target group updated (when toGroup is set).

201Copy created. data.id is the Public ID of the new group, and data.lineItems lists the copied line items with their new ids.

400Validation error, for example parent_item_id missing or not a Scope of Work page in the destination proposal, or the destination proposal is pending signature, won, or lost.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Group, destination proposal, or destination page not found.

409The source proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/groups/{id}/move

MoveGroup

Change a group's position on its Scope of Work page. Set after_id to the Public ID of another group on the same page to place this group right after it, or to the Public ID of the proposal to place it first. The group stays on its current page, and its line items move with it. To set the order of many groups at once, use ReorderProposalGroups. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the group to move, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

after_idstringrequired

Public ID of the group to place this one after, or Public ID of the proposal to place it first on its page.

Example

{
  "after_id": "ijklmnop5678"
}

Responses

200Group moved.

dataobject

idstring

Public ID of the moved group.

Example

{
  "data": {
    "id": "zw5FD5HGcfE3"
  }
}

400after_id is missing, or it is not a group or the proposal this group belongs to.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Group not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/groups/{id}/unarchive

UnarchiveGroup

Restore an archived group so it shows in the proposal again, with its line items and settings. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the archived group, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Responses

204Group restored. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Group not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/library/bulk-archive

BulkArchiveLibraryItems

Request Body

itemIdsarray of stringrequired

Public IDs of library line items, groups, or pages to archive. Not editor Item IDs (externalItemId).

Example

{
  "itemIds": [
    "zw5FD5HGcfE3",
    "kP3mNq8rT2xY"
  ]
}

Responses

200Archive finished. archivedCount can be lower than itemIds.length when errors is present.

archivedCountinteger

Number of items successfully archived

errorsarray of string

Messages for ids that were not archived. Omitted when every id succeeded.

messagestring

Success message

Example

{
  "archivedCount": 3,
  "errors": [
    "example-string"
  ],
  "message": "Successfully archived 3 items"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}/groups

ListGroups

Return the groups in a proposal, across all Scope of Work pages, with their Public IDs and settings. Line items are not included; use GetGroup or ListItems with a returned group id to read line items and their prices. Archived groups are left out unless you pass archived.

Path Parameters

idstringrequired

Public ID of the proposal (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Query Parameters

archivedenum

falsedefaulttrueany

Filter by archive status (false=non-archived, true=archived only, any=both)

limitinteger

Default: 50. Number of groups to return (max 100).

offsetinteger

Default: 0. Number of groups to skip.

orderenum

ascdefaultdesc

Sort order

searchstring

Search term to filter groups by name or content

sortenum

order_keydefaultnamecreated_atupdated_at

Field to sort by

Responses

200Successful response with groups list

object

Example

null

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/groups/reorder

ReorderProposalGroups

Set the display order of groups. Send groupIds as the Public IDs of the groups in the order you want; the first id is shown first. Groups stay on their current Scope of Work page, so list groups from the same page together. Every id must be a group in this proposal, otherwise the request fails with 400 and nothing changes. To move one group, use MoveGroup. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the proposal (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

groupIdsarray of stringrequired

Public IDs of groups in this proposal, in the desired order. Must not be empty.

Example

{
  "groupIds": [
    "sL6mScw17PKV",
    "RCNMjEEJrf7e"
  ]
}

Responses

200Groups reordered successfully

dataobject

reorderedCountinteger

Number of groups that were reordered

messagestring

Example

{
  "data": {
    "reorderedCount": 2
  },
  "message": "Groups reordered successfully"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

Line Items(13)

GET/groups/{id}/items

ListItems

Return the line items in one group, in display order by default. Each line item includes its Public ID (id) and its price. For fixed prices, price.value is in dollars, not cents. To list a line item's modifications, use ListModifications. Archived and deleted line items are not included. Use a returned id with UpdateItem (PATCH /api/items/{id}) to change a line item's price.

Path Parameters

idstringrequired

Public ID of the group, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Query Parameters

limitinteger

Default: 20. Number of line items per page (max 100).

orderenum

ascdefaultdesc

Sort order

pageinteger

Default: 1. Page number for pagination

searchstring

Search term to filter items by name

sortenum

order_keydefaultnamecreated_atupdated_at

Field to sort by

Responses

200Items retrieved successfully

dataarray of LineItem

archived_atnullable string

When the item was archived (ISO 8601 timestamp), or null if active

childCountnumber

Number of child modifications

childrenarray of Modification

Array of child modifications/options for this line item

created_atstring

When the item was created (ISO 8601 timestamp)

descriptionstring

HTML content for the item description

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update so Discount can be set without nesting. Pass null to clear.

discountExemptboolean

Whether this item is exempt from proposal-wide percentage discounts

externalItemIdnullable string

Optional customer-owned identifier (SKU, CRM id, etc.). Printable characters, including spaces and punctuation. Max 255 characters. Control characters and non-ASCII are not allowed. Shown in the editor as "Item ID" when the org setting `proposals.showItemId` is on. Included on authenticated API, webhooks, and JSON export. Never shown to recipients. Named `externalItemId` so it is not confused with this object's `id` (SPT public id).

hasLinkedItemsboolean

Whether this library item has other items linked to it (library items only)

hiddenboolean

Whether this item is hidden from the client view

hideModificationsboolean

Whether to hide modifications/options for this item

idstring

Unique line item identifier

in_libraryboolean

Whether this item belongs to the library (true) or a regular proposal (false/undefined)

integrationsobject

External integration references for this item

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

is_archivedboolean

Whether the item is archived

isOptionalboolean

Whether this line item is optional for the client

isSelectedboolean

Whether this optional item is currently selected

labelstring

Custom display label for this line item

linkedLibraryItemIdnullable string

Public ID of the library item this is linked to (templates only)

lockedboolean

Logic lock. Hidden always implies locked. Locked items are not in totals and cannot be changed except by the engine.

markupExemptboolean

Whether this item is exempt from markup

modificationsLabelstring

Custom label for the modifications section (e.g., "Options", "Add-ons")

namestring

Line item name/title

order_keynumber

Sort position within the group

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

parent_idnullable string

The public_id of the parent group or scope that this item belongs to

pricePriceConfig

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification (ignored when hideModifications is true)

selectionTypeenum

How child modifications can be selected (single, multiple, etc.)

singlemultipleloose

showCentsboolean

Show cents on this item. Only used when `skipRounding` is true.

skipRoundingboolean

Skip Use Rounded Amounts for this item. Ignored unless that pricing table has Use Rounded Amounts on. `showCents` then shows cents on this item only.

startExpandedboolean

Whether modifications are expanded by default

tagsarray of string

Tags/labels applied to this item

taxExemptboolean

Whether this item is exempt from sales tax

termsstring

HTML added to [dynamic_terms] when this line item qualifies. Gated by the dynamic_terms add-on.

updated_atstring

When the item was last updated (ISO 8601 timestamp)

paginationPagination

Example

{
  "data": [
    {
      "children": [
        {
          "discountExempt": true,
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "markupExempt": true,
          "name": "example-string",
          "price": {},
          "taxExempt": true,
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "discount": {
            "added": true,
            "amount": 100,
            "isSelected": true,
            "scope": "unit",
            "type": "percentage"
          },
          "externalItemId": "example-string",
          "hidden": true,
          "integrations": {
            "quickbooks": {
              "productId": "example-string"
            }
          },
          "internalCost": {
            "amount": 100
          },
          "internalNotes": "example-string",
          "is_archived": true,
          "kind": "mod",
          "label": "example-string",
          "locked": true,
          "outOfPocket": {
            "amount": 100,
            "label": "example-string"
          },
          "requireSelection": true,
          "selectionType": "single",
          "showCents": true,
          "skipRounding": true,
          "terms": "example-string",
          "updated_at": "example-string"
        }
      ],
      "description": "example-string",
      "discountExempt": true,
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "markupExempt": true,
      "name": "example-string",
      "price": {
        "frequency": "once",
        "model": "fixed",
        "discount": {},
        "isRange": true,
        "maxValue": 100,
        "quantity": {},
        "value": 100
      },
      "taxExempt": true,
      "archived_at": "example-string",
      "childCount": 100,
      "created_at": "example-string",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "externalItemId": "example-string",
      "hasLinkedItems": true,
      "hidden": true,
      "hideModifications": true,
      "in_library": true,
      "integrations": {
        "quickbooks": {
          "productId": "example-string"
        }
      },
      "internalCost": {
        "amount": 100
      },
      "internalNotes": "example-string",
      "is_archived": true,
      "label": "example-string",
      "linkedLibraryItemId": "example-string",
      "locked": true,
      "modificationsLabel": "example-string",
      "order_key": 100,
      "outOfPocket": {
        "amount": 100,
        "frequency": "once",
        "label": "example-string"
      },
      "parent_id": "example-string",
      "requireSelection": true,
      "selectionType": "single",
      "showCents": true,
      "skipRounding": true,
      "startExpanded": true,
      "tags": [
        "example-string"
      ],
      "terms": "example-string",
      "updated_at": "example-string"
    }
  ]
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Group not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/groups/{id}/items/reorder

ReorderItems

Set the display order of line items inside one group. Send itemIds as the Public IDs of the group's line items in the order you want; the first id is shown first. Every id must be a line item in this group, otherwise the request fails with 400 and nothing changes. Line items you leave out keep their current position value. To move one line item, or move it into a different group, use MoveItem. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the group, as returned by the API (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

Request Body

itemIdsarray of stringrequired

Public IDs of line items in this group, in the desired order. Must not be empty.

Example

{
  "itemIds": [
    "qeP5CKvwBveC",
    "N66wN1Yhese9",
    "Vv5EYHv5aNEx"
  ]
}

Responses

200Items reordered successfully

dataobject

reorderedCountinteger

Number of items that were reordered

messagestring

Example

{
  "data": {
    "reorderedCount": 3
  },
  "message": "Items reordered successfully"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Group not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items

CreateItem

Create a new line item. Send exactly one of parent_group (the Public ID of a group in a proposal, for example zw5FD5HGcfE3) or in_library: true (saves the line item to your organization's library). The line item fields go inside "item". A library line item created this way shows up in the Line Items library and in proposal search. item.name and item.price are required. price needs model and, for every model except none, frequency. For fixed and percent, value is also required. For fixed, value is the unit price in dollars (major currency units), not cents. For percent, value is a whole-number percent (15 = 15%). item.tags is an array of strings and sets the tags. item.externalItemId is your own part number or SKU. item.internalCost is the internal cost in dollars ({ "amount": 40 }), when the profit margins add-on is on. To change any of these later, including tags, PATCH /api/items/{id} with a flat body (no "item" wrapper). Sending tags there replaces the whole list. Library example: { "in_library": true, "item": { "name": "Indoor camera", "description": "4K dome camera.", "price": { "model": "fixed", "value": 499, "frequency": "once" }, "tags": ["cameras", "indoor"], "externalItemId": "CAM-100", "internalCost": { "amount": 210 } } }. Proposal example: { "parent_group": "zw5FD5HGcfE3", "item": { "name": "Website design", "price": { "model": "fixed", "value": 2500, "frequency": "once" } } }. Create one line item per request. If the library already has that name, the response is 409 and includes existingItemId; PATCH that id to update it. To place a line item next to an existing item, or to create a group or side-by-side on a proposal, POST /api/proposals/{id}/items is usually simpler. Proposals that are pending signature, won, or lost cannot be edited (409).

Request Body

itemobjectrequired

parent_groupstring

Public ID of a group in a proposal. The line item is added to that group.

in_libraryboolean

Create the line item in your organization's library.

Example

{
  "item": {
    "name": "example-string",
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "discountExempt": true,
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internal_cost": {
      "amount": 100
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "isOptional": true,
    "isSelected": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "markupExempt": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "source_library_item_id": "example-string",
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "taxExempt": true,
    "terms": "example-string"
  },
  "in_library": true,
  "parent_group": "zw5FD5HGcfE3"
}

Responses

201Line item created. data.id is its Public ID.

dataLineItem

archived_atnullable string

When the item was archived (ISO 8601 timestamp), or null if active

childCountnumber

Number of child modifications

childrenarray of Modification

Array of child modifications/options for this line item

created_atstring

When the item was created (ISO 8601 timestamp)

descriptionstring

HTML content for the item description

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update so Discount can be set without nesting. Pass null to clear.

discountExemptboolean

Whether this item is exempt from proposal-wide percentage discounts

externalItemIdnullable string

hasLinkedItemsboolean

Whether this library item has other items linked to it (library items only)

hiddenboolean

Whether this item is hidden from the client view

hideModificationsboolean

Whether to hide modifications/options for this item

idstring

Unique line item identifier

in_libraryboolean

Whether this item belongs to the library (true) or a regular proposal (false/undefined)

integrationsobject

External integration references for this item

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

is_archivedboolean

Whether the item is archived

isOptionalboolean

Whether this line item is optional for the client

isSelectedboolean

Whether this optional item is currently selected

labelstring

Custom display label for this line item

linkedLibraryItemIdnullable string

Public ID of the library item this is linked to (templates only)

lockedboolean

Logic lock. Hidden always implies locked. Locked items are not in totals and cannot be changed except by the engine.

markupExemptboolean

Whether this item is exempt from markup

modificationsLabelstring

Custom label for the modifications section (e.g., "Options", "Add-ons")

namestring

Line item name/title

order_keynumber

Sort position within the group

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

parent_idnullable string

The public_id of the parent group or scope that this item belongs to

pricePriceConfig

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification (ignored when hideModifications is true)

selectionTypeenum

How child modifications can be selected (single, multiple, etc.)

singlemultipleloose

showCentsboolean

Show cents on this item. Only used when `skipRounding` is true.

skipRoundingboolean

Skip Use Rounded Amounts for this item. Ignored unless that pricing table has Use Rounded Amounts on. `showCents` then shows cents on this item only.

startExpandedboolean

Whether modifications are expanded by default

tagsarray of string

Tags/labels applied to this item

taxExemptboolean

Whether this item is exempt from sales tax

termsstring

HTML added to [dynamic_terms] when this line item qualifies. Gated by the dynamic_terms add-on.

updated_atstring

When the item was last updated (ISO 8601 timestamp)

Example

{
  "data": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Group or organization not found

409The proposal is locked (pending signature, won, lost, or a locked customer version), or a library item with this name already exists (only when in_library is true). A duplicate library name returns error.code DUPLICATE_NAME and error.existingItemId. PATCH /api/items/{existingItemId} to update that library line item.

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/items/{id}

GetItem

Same URL for a line item, a side-by-side, or a modification. Pass that object's Public ID (the id the API returned), not the editor Item ID field (externalItemId, your own SKU or CRM id). Line item: GET /api/items/zw5FD5HGcfE3 returns its price, settings, parent_id (the group's Public ID), children (its modifications), and childCount. Modification: GET /api/items/Qm7rT2vXk9Lp (the modification's Public ID) returns the modification, with parent_id set to its line item. GetModification returns the same data. Side-by-side: GET /api/items/Hs3kW8nYb4Rd (the side-by-side's Public ID) returns its id, name, description, kind "side_by_side", and selectionType. Its columns and features are not included in this response.

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

200The item, including parent_id, children, and childCount.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found

errorstring

Example

{
  "error": "Item not found"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/items/{id}

UpdateItem

Change an existing item in place, including its price. Only the fields you send change. The body shape depends on the kind of item. LINE ITEM (and modification): send a flat UpdateLineItemApiInput body, with no "item" wrapper. To change the cost, send price. price is a full replacement, so include model, value, and frequency together. For a fixed price, value is the unit price in major currency units (dollars for USD), not cents. Example that sets the price to $379 one-time: { "price": { "model": "fixed", "value": 379, "frequency": "once" } }. For a percent price, value is a whole-number percent (15 = 15%). Sending only { "price": { "value": 379 } } does not update the price; model is required. SIDE-BY-SIDE: wrap the fields in "item": { "item": { "name", "html", "attrs", "order_key" } }. attrs is merged per key, so keys you leave out are kept. attrs.columns replaces the whole columns array: read the current columns with GetProposal, change them, and send the complete array back, keeping each column's id. Each column has name, price (a number in dollars), frequency, and feeType (fixed, text, or none). Example: { "item": { "attrs": { "columns": [ { "id": "3f2c...", "name": "Basic", "price": 499, "frequency": "monthly", "feeType": "fixed" } ] } } }. To recolor a side-by-side, set item.attrs.theme to a built-in id (metals, ocean, forest, sunset, monochrome, pastel, neon, earth, berry, corporate) without resending columns. Or set item.attrs.design for a custom theme (container, featuresColumn, heading, and a columns palette that cycles). A design object on an individual column overrides that column. theme and design are request-only — the saved item stores the painted colors, not the theme id. The {id} is the Public ID the API returns (for example zw5FD5HGcfE3), not the editor field labeled "Item ID" (externalItemId). To set your own id, send externalItemId (printable characters, including spaces and punctuation; max 255; control characters and non-ASCII are not allowed; null or "" clears it). tags replaces the tag list; omit tags to leave them unchanged. Send tags: [] to clear them. The same call updates a library line item or library side-by-side when {id} is that library entry's Public ID. Proposals that are pending signature, won, or lost cannot be edited (409 PROPOSAL_LOCKED). The same applies when the customer-visible version of a versioned proposal is locked.

Path Parameters

idstringrequired

Public ID of the line item, modification, or side-by-side, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

Example

{
  "description": "example-string",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "discountExempt": true,
  "externalItemId": "example-string",
  "hasLinkedItems": true,
  "hidden": true,
  "hideModifications": true,
  "in_library": true,
  "integrations": {
    "quickbooks": {
      "productId": "example-string"
    }
  },
  "internal_cost": {
    "amount": 100
  },
  "internalCost": {
    "amount": 100
  },
  "internalNotes": "example-string",
  "isOptional": true,
  "isSelected": true,
  "label": "example-string",
  "linkedLibraryItemId": "example-string",
  "locked": true,
  "markupExempt": true,
  "modificationsLabel": "example-string",
  "name": "example-string",
  "order_key": 100,
  "outOfPocket": {
    "amount": 100,
    "frequency": "once",
    "label": "example-string"
  },
  "parent_id": "example-string",
  "price": {
    "frequency": "once",
    "model": "fixed",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "isRange": true,
    "maxValue": 100,
    "quantity": {
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "current": 100,
      "volumePricingEnabled": true,
      "volumeTiers": []
    },
    "value": 100
  },
  "requireSelection": true,
  "selectionType": "single",
  "showCents": true,
  "skipRounding": true,
  "startExpanded": true,
  "tags": [
    "example-string"
  ],
  "taxExempt": true,
  "terms": "example-string"
}

Responses

200Item updated. Returns the item as it is now stored.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

400Validation error (for example an invalid price.model or frequency, an empty name, or a non-positive order_key).

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to edit this proposal.

404Item not found

409The proposal is locked (PROPOSAL_LOCKED: pending signature, won, lost, or a locked customer version), or a library item with this name already exists (DUPLICATE_NAME).

errorobject

Example

{
  "error": {
    "code": "DUPLICATE_NAME",
    "existingItemId": "example-string",
    "message": "A line item with the name \"Item Name\" already exists in the library."
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/items/{id}

DeleteItem

Same URL for a line item, a side-by-side, or a modification. Pass that object's Public ID (the id the API returned), not the editor Item ID field (externalItemId). Line item: DELETE /api/items/zw5FD5HGcfE3. Side-by-side: DELETE /api/items/Hs3kW8nYb4Rd (the side-by-side's Public ID). Modification: DELETE /api/items/Qm7rT2vXk9Lp (the modification's Public ID). The object is soft-deleted: it disappears from the proposal and from API responses, and the proposal totals are recalculated. To remove it but keep the option to bring it back, use ArchiveItem and UnarchiveItem instead. Requires permission to delete proposals.

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item deleted. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to delete from this proposal.

404Item not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/archive

ArchiveItem

Same URL for a line item, a side-by-side, or a modification. Pass that object's Public ID (the id the API returned), not the editor Item ID field (externalItemId). Line item: POST /api/items/zw5FD5HGcfE3/archive. Side-by-side: POST /api/items/Hs3kW8nYb4Rd/archive (the side-by-side's Public ID). Modification: POST /api/items/Qm7rT2vXk9Lp/archive (the modification's Public ID). Archiving removes the object from the proposal in a way you can undo. Archived objects are hidden from the proposal and left out of list responses. Bring one back with UnarchiveItem. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item archived. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/duplicate

DuplicateItem

Same URL for a line item, a side-by-side, or a modification. Pass the Public ID of the object to copy (the id the API returned), not the editor Item ID field (externalItemId). Line item: POST /api/items/zw5FD5HGcfE3/duplicate with an empty body places the copy right after the original in the same group, named "<original name> - Copy", with its modifications copied too. Side-by-side: POST /api/items/Hs3kW8nYb4Rd/duplicate with an empty body adds "Copy of <original name>" at the end of the same Scope of Work page, with the same columns and features. The response includes attrs (columns and features). Modification: POST /api/items/Qm7rT2vXk9Lp/duplicate with an empty body places the copy right after the original under the same line item, named "<original name> - Copy". A modification can only be copied within its own proposal; to move it to another proposal, copy its parent line item. To copy a line item or side-by-side into another proposal, send proposalId (Public ID of the destination proposal) and parent_item_id (Public ID of the destination group for a line item, or of a Scope of Work page for a side-by-side). A copy into another proposal keeps the original name unless you send name. The destination cannot be pending signature, won, or lost. Line items only: toLibrary true saves the line item to your library, and toItem overwrites an existing line item with this one's content. To change the copy's price afterwards, PATCH /api/items/{id} (line item or side-by-side) or PATCH /api/items/{id}/modifications/{modificationId} (modification) with the id returned here.

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification to copy, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

namestring

Name for the copy. Default in the same proposal is "<original name> - Copy" (line items and modifications) or "Copy of <original name>" (side-by-sides); the original name when copying into another proposal.

includeModifiersboolean

Also copy the line item's modifications.

orderKeynumber

Position for the copy. Default is right after the original.

proposalIdstring

Public ID of the destination proposal, to copy into another proposal.

parent_item_idstring

With proposalId. Public ID of the destination group (for a line item) or Scope of Work page (for a side-by-side).

toLibraryboolean

Save a copy to your organization's library instead.

tagsarray of string

With toLibrary. Tags for the library copy.

toItemstring

Public ID of an existing item to overwrite with this item's content (the "update from" action). No new item is created.

Example

{
  "includeModifiers": true,
  "name": "Frontend Development - Copy",
  "orderKey": 100,
  "parent_item_id": "example-string",
  "proposalId": "aB3dE5fG7hJ9",
  "tags": [
    "example-string"
  ],
  "toItem": "example-string",
  "toLibrary": true
}

Responses

201Copy created. item.id is the Public ID of the copy.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

400Validation error, for example parent_item_id missing when copying to another proposal, a modification sent with a different proposalId, or the destination proposal is pending signature, won, or lost.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Line item, destination proposal, or destination parent not found.

409The source proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/move

MoveItem

Same URL for a line item, a side-by-side, or a modification. Pass the Public ID of the object to move (the id the API returned), not the editor Item ID field (externalItemId). after_id decides the new position. Line item: POST /api/items/zw5FD5HGcfE3/move with after_id set to another line item's Public ID (placed right after it, moving into that line item's group if different), a group's Public ID (placed first in that group), or null (placed first in its current group). Side-by-side: POST /api/items/Hs3kW8nYb4Rd/move with after_id set to the Public ID of another side-by-side on the same Scope of Work page (placed right after it), or null (placed first on the page). Do not pass a group's Public ID for a side-by-side. Modification: POST /api/items/Qm7rT2vXk9Lp/move with after_id set to the Public ID of another modification on the same line item (placed right after it), or null (placed first under its line item). The price and other settings do not change. To set the order of many line items at once, use ReorderItems. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification to move, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

after_idstringrequired

Required (may be null). Public ID of the sibling to place this object after, or (for a line item) Public ID of a group to place it first in that group. null places it first under its current parent.

Example

{
  "after_id": "ijklmnop5678"
}

Responses

200Object moved.

dataobject

idstring

Public ID of the moved object.

Example

{
  "data": {
    "id": "zw5FD5HGcfE3"
  }
}

400after_id is missing from the body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Object (or the after_id target) not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/unarchive

UnarchiveItem

Same URL for a line item, a side-by-side, or a modification. Pass the archived object's Public ID (the id the API returned), not the editor Item ID field (externalItemId). Line item: POST /api/items/zw5FD5HGcfE3/unarchive. Side-by-side: POST /api/items/Hs3kW8nYb4Rd/unarchive (the side-by-side's Public ID). Modification: POST /api/items/Qm7rT2vXk9Lp/unarchive (the modification's Public ID). The object shows in the proposal again, with the price and settings it had when archived. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the archived line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item restored. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/library/bulk-archive

BulkArchiveLibraryItems

Request Body

itemIdsarray of stringrequired

Public IDs of library line items, groups, or pages to archive. Not editor Item IDs (externalItemId).

Example

{
  "itemIds": [
    "zw5FD5HGcfE3",
    "kP3mNq8rT2xY"
  ]
}

Responses

200Archive finished. archivedCount can be lower than itemIds.length when errors is present.

archivedCountinteger

Number of items successfully archived

errorsarray of string

Messages for ids that were not archived. Omitted when every id succeeded.

messagestring

Success message

Example

{
  "archivedCount": 3,
  "errors": [
    "example-string"
  ],
  "message": "Successfully archived 3 items"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/library/items

ListLibraryItems

List line items in your organization's library. Each item's id is its Public ID. externalItemId is the editor Item ID (your part number or SKU), and price is the library price. Use externalItemId to look up one part. Omit it to page through the library. Results stay in your organization. Up to 100 items per request; use offset with pagination.total to read the rest.

Query Parameters

externalItemIdstring

Exact editor Item ID (your part number or SKU). Printable characters only, max 255. Example: Widget (A) + 1

limitinteger

Default: 50. Number of items to return

offsetinteger

Default: 0. Number of items to skip

orderenum

ascdefaultdesc

Sort order

searchstring

Filter by name or description. Does not match Item ID; use externalItemId for that.

sortenum

order_keydefaultnamecreated_atupdated_at

Field to sort by

tagstring

Exact library tag. Omit to include every tag.

Responses

200Library items retrieved successfully

dataarray of LineItem

archived_atnullable string

When the item was archived (ISO 8601 timestamp), or null if active

childCountnumber

Number of child modifications

childrenarray of Modification

Array of child modifications/options for this line item

created_atstring

When the item was created (ISO 8601 timestamp)

descriptionstring

HTML content for the item description

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update so Discount can be set without nesting. Pass null to clear.

discountExemptboolean

Whether this item is exempt from proposal-wide percentage discounts

externalItemIdnullable string

hasLinkedItemsboolean

Whether this library item has other items linked to it (library items only)

hiddenboolean

Whether this item is hidden from the client view

hideModificationsboolean

Whether to hide modifications/options for this item

idstring

Unique line item identifier

in_libraryboolean

Whether this item belongs to the library (true) or a regular proposal (false/undefined)

integrationsobject

External integration references for this item

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

is_archivedboolean

Whether the item is archived

isOptionalboolean

Whether this line item is optional for the client

isSelectedboolean

Whether this optional item is currently selected

labelstring

Custom display label for this line item

linkedLibraryItemIdnullable string

Public ID of the library item this is linked to (templates only)

lockedboolean

Logic lock. Hidden always implies locked. Locked items are not in totals and cannot be changed except by the engine.

markupExemptboolean

Whether this item is exempt from markup

modificationsLabelstring

Custom label for the modifications section (e.g., "Options", "Add-ons")

namestring

Line item name/title

order_keynumber

Sort position within the group

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

parent_idnullable string

The public_id of the parent group or scope that this item belongs to

pricePriceConfig

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification (ignored when hideModifications is true)

selectionTypeenum

How child modifications can be selected (single, multiple, etc.)

singlemultipleloose

showCentsboolean

Show cents on this item. Only used when `skipRounding` is true.

skipRoundingboolean

Skip Use Rounded Amounts for this item. Ignored unless that pricing table has Use Rounded Amounts on. `showCents` then shows cents on this item only.

startExpandedboolean

Whether modifications are expanded by default

tagsarray of string

Tags/labels applied to this item

taxExemptboolean

Whether this item is exempt from sales tax

termsstring

HTML added to [dynamic_terms] when this line item qualifies. Gated by the dynamic_terms add-on.

updated_atstring

When the item was last updated (ISO 8601 timestamp)

paginationobject

Example

{
  "data": [
    {
      "children": [
        {
          "discountExempt": true,
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "markupExempt": true,
          "name": "example-string",
          "price": {},
          "taxExempt": true,
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "discount": {
            "added": true,
            "amount": 100,
            "isSelected": true,
            "scope": "unit",
            "type": "percentage"
          },
          "externalItemId": "example-string",
          "hidden": true,
          "integrations": {
            "quickbooks": {
              "productId": "example-string"
            }
          },
          "internalCost": {
            "amount": 100
          },
          "internalNotes": "example-string",
          "is_archived": true,
          "kind": "mod",
          "label": "example-string",
          "locked": true,
          "outOfPocket": {
            "amount": 100,
            "label": "example-string"
          },
          "requireSelection": true,
          "selectionType": "single",
          "showCents": true,
          "skipRounding": true,
          "terms": "example-string",
          "updated_at": "example-string"
        }
      ],
      "description": "example-string",
      "discountExempt": true,
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "markupExempt": true,
      "name": "example-string",
      "price": {
        "frequency": "once",
        "model": "fixed",
        "discount": {},
        "isRange": true,
        "maxValue": 100,
        "quantity": {},
        "value": 100
      },
      "taxExempt": true,
      "archived_at": "example-string",
      "childCount": 100,
      "created_at": "example-string",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "externalItemId": "example-string",
      "hasLinkedItems": true,
      "hidden": true,
      "hideModifications": true,
      "in_library": true,
      "integrations": {
        "quickbooks": {
          "productId": "example-string"
        }
      },
      "internalCost": {
        "amount": 100
      },
      "internalNotes": "example-string",
      "is_archived": true,
      "label": "example-string",
      "linkedLibraryItemId": "example-string",
      "locked": true,
      "modificationsLabel": "example-string",
      "order_key": 100,
      "outOfPocket": {
        "amount": 100,
        "frequency": "once",
        "label": "example-string"
      },
      "parent_id": "example-string",
      "requireSelection": true,
      "selectionType": "single",
      "showCents": true,
      "skipRounding": true,
      "startExpanded": true,
      "tags": [
        "example-string"
      ],
      "terms": "example-string",
      "updated_at": "example-string"
    }
  ],
  "pagination": {}
}

400externalItemId is blank, too long, or contains a character Item ID does not allow.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/library/items/check-duplicate

CheckDuplicateItemName

Look up a line item name in your organization's library before creating one. Send the name as a query parameter. exists is true when a library line item already uses that name, and itemId is that item's Public ID (the id the API returns, not the editor Item ID / externalItemId). CreateItem with in_library true also returns 409 DUPLICATE_NAME and existingItemId when the name is taken; this call is the check you can make first.

Query Parameters

namestringrequired

Line item name to look up in the library.

Responses

200Check result

existsboolean

True when a library line item already uses this name.

itemIdstring

Public ID of the existing library line item when exists is true.

Example

{
  "exists": true,
  "itemId": "example-string"
}

400Missing name parameter

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

Side-by-Sides(9)

GET/items/{id}

GetItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

200The item, including parent_id, children, and childCount.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found

errorstring

Example

{
  "error": "Item not found"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/items/{id}

UpdateItem

Path Parameters

idstringrequired

Public ID of the line item, modification, or side-by-side, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

Example

{
  "description": "example-string",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "discountExempt": true,
  "externalItemId": "example-string",
  "hasLinkedItems": true,
  "hidden": true,
  "hideModifications": true,
  "in_library": true,
  "integrations": {
    "quickbooks": {
      "productId": "example-string"
    }
  },
  "internal_cost": {
    "amount": 100
  },
  "internalCost": {
    "amount": 100
  },
  "internalNotes": "example-string",
  "isOptional": true,
  "isSelected": true,
  "label": "example-string",
  "linkedLibraryItemId": "example-string",
  "locked": true,
  "markupExempt": true,
  "modificationsLabel": "example-string",
  "name": "example-string",
  "order_key": 100,
  "outOfPocket": {
    "amount": 100,
    "frequency": "once",
    "label": "example-string"
  },
  "parent_id": "example-string",
  "price": {
    "frequency": "once",
    "model": "fixed",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "isRange": true,
    "maxValue": 100,
    "quantity": {
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "current": 100,
      "volumePricingEnabled": true,
      "volumeTiers": []
    },
    "value": 100
  },
  "requireSelection": true,
  "selectionType": "single",
  "showCents": true,
  "skipRounding": true,
  "startExpanded": true,
  "tags": [
    "example-string"
  ],
  "taxExempt": true,
  "terms": "example-string"
}

Responses

200Item updated. Returns the item as it is now stored.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

400Validation error (for example an invalid price.model or frequency, an empty name, or a non-positive order_key).

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to edit this proposal.

404Item not found

409The proposal is locked (PROPOSAL_LOCKED: pending signature, won, lost, or a locked customer version), or a library item with this name already exists (DUPLICATE_NAME).

errorobject

Example

{
  "error": {
    "code": "DUPLICATE_NAME",
    "existingItemId": "example-string",
    "message": "A line item with the name \"Item Name\" already exists in the library."
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/items/{id}

DeleteItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item deleted. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to delete from this proposal.

404Item not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/archive

ArchiveItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item archived. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/duplicate

DuplicateItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification to copy, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

namestring

includeModifiersboolean

Also copy the line item's modifications.

orderKeynumber

Position for the copy. Default is right after the original.

proposalIdstring

Public ID of the destination proposal, to copy into another proposal.

parent_item_idstring

With proposalId. Public ID of the destination group (for a line item) or Scope of Work page (for a side-by-side).

toLibraryboolean

Save a copy to your organization's library instead.

tagsarray of string

With toLibrary. Tags for the library copy.

toItemstring

Public ID of an existing item to overwrite with this item's content (the "update from" action). No new item is created.

Example

{
  "includeModifiers": true,
  "name": "Frontend Development - Copy",
  "orderKey": 100,
  "parent_item_id": "example-string",
  "proposalId": "aB3dE5fG7hJ9",
  "tags": [
    "example-string"
  ],
  "toItem": "example-string",
  "toLibrary": true
}

Responses

201Copy created. item.id is the Public ID of the copy.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Line item, destination proposal, or destination parent not found.

409The source proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/move

MoveItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification to move, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

after_idstringrequired

Required (may be null). Public ID of the sibling to place this object after, or (for a line item) Public ID of a group to place it first in that group. null places it first under its current parent.

Example

{
  "after_id": "ijklmnop5678"
}

Responses

200Object moved.

dataobject

idstring

Public ID of the moved object.

Example

{
  "data": {
    "id": "zw5FD5HGcfE3"
  }
}

400after_id is missing from the body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Object (or the after_id target) not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/unarchive

UnarchiveItem

Path Parameters

idstringrequired

Public ID of the archived line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item restored. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/library/side-by-sides

CreateLibrarySideBySide

Save a new side-by-side in your organization's library. name is required. columns is the list of packages; each column price is a number in dollars (major currency units), not cents. Column and feature ids are generated when you omit them. Ids you send are kept. Example: { "name": "Camera packages", "description": "Choose a package.", "selectionType": "single", "style": "standard", "columns": [ { "name": "Basic", "price": 499, "frequency": "once" }, { "name": "Pro", "price": 899, "frequency": "monthly" } ] }. A library name that already exists returns 409 with existingSideBySideId. To change one later, PATCH /api/items/{id} with an { "item": { ... } } body, using the returned id. To create a side-by-side on a proposal instead, POST /api/proposals/{id}/items with type=side_by_side. tags is an optional list of library tags.

Request Body

namestringrequired

Display name. Must be unique in the library.

descriptionstring

HTML description shown above the columns.

selectionTypeenum

How many columns a client may select. Default single.

singlemultipleloose

styleenum

standard is pricing cards. comparison is a feature table (send features). Default standard.

standardcomparison

columnsarray of object

The packages or columns. Each price is a number in dollars. An omitted id is generated.

featuresarray of object

Comparison-style feature rows. An omitted id is generated.

containerDesignobject

Optional visual settings for the side-by-side container.

featuresColumnDesignobject

Optional visual settings for the features column (comparison style).

headingDesignobject

Optional visual settings for comparison-style heading rows.

themeenum

Built-in color theme (the design drawer's Quick Themes). Paints column colors, the container, and — when style is comparison — the features column and headings. monochrome is the Mono theme. Not stored; the painted colors are.

metalsoceanforestsunsetmonochromepastelneonearthberrycorporate

tagsarray of string

Optional library tags. Omit to create the side-by-side untagged.

designobject

Custom theme. Use instead of theme, or with theme to override specific settings. container, featuresColumn, heading, and columns (a palette cycled across the columns).

Example

{
  "name": "example-string",
  "columns": [
    {
      "description": "example-string",
      "feeType": "fixed",
      "frequency": "once",
      "id": "example-string",
      "includedFeatures": [
        "example-string"
      ],
      "isSelected": true,
      "name": "example-string",
      "price": 499
    }
  ],
  "containerDesign": {},
  "description": "example-string",
  "design": {
    "columns": [
      {}
    ],
    "container": {},
    "featuresColumn": {},
    "heading": {}
  },
  "features": [
    {
      "id": "example-string",
      "name": "example-string",
      "order_key": 100
    }
  ],
  "featuresColumnDesign": {},
  "headingDesign": {},
  "selectionType": "single",
  "style": "standard",
  "tags": [
    "example-string"
  ],
  "theme": "metals"
}

Responses

201Side-by-side created. id is its Public ID.

columnsarray of object

created_atstring

descriptionstring

featuresarray of object

idstring

Public ID of the new library side-by-side.

namestring

selectionTypestring

stylestring

updated_atstring

Example

{
  "columns": [
    {}
  ],
  "created_at": "2024-01-20T15:30:00Z",
  "description": "example-string",
  "features": [
    {}
  ],
  "id": "Hs3kW8nYb4Rd",
  "name": "example-string",
  "selectionType": "example-string",
  "style": "example-string",
  "updated_at": "2024-01-20T15:30:00Z"
}

400Name is missing.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Organization not found.

409A library side-by-side with this name already exists. error.code is DUPLICATE_NAME and error.existingSideBySideId is the Public ID to update with PATCH /api/items/{id}.

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/items

PostProposalsItems

Path Parameters

idstringrequired

Public ID of the proposal.

Request Body

typeenumrequired

The kind of item to create.

line_itemgroupside_by_side

namestringrequired

Display name of the item.

descriptionstring

Optional rich-text/HTML description (stored as the item's content).

priceobject

Required for type=line_item. Pricing definition, for example { "model": "fixed", "value": 379, "frequency": "once" }. To change it later, PATCH /api/items/{id} with a new price.

optionalboolean

Whether the item is optional (client can toggle it).

selectedboolean

Whether an optional item is selected by default.

tagsarray of string

Tags to attach to the item.

target_group_idstring

For type=line_item. Group to add into (default first group).

scope_of_work_page_idstring

For type=group or side_by_side. Scope of Work page to add under (default first SOW page).

columnsarray of object

Required for type=side_by_side. The selectable packages/columns. Column ids are generated server-side if omitted.

featuresarray of object

For type=side_by_side comparison style — the feature rows.

selection_typeenum

For type=side_by_side. How many columns a client may select (default loose).

singlemultipleloose

styleenum

For type=side_by_side. Layout style (default standard).

standardcomparison

themeenum

For type=side_by_side. Built-in color theme (the design drawer's Quick Themes). monochrome is the Mono theme.

metalsoceanforestsunsetmonochromepastelneonearthberrycorporate

designobject

For type=side_by_side. Custom theme. Use instead of theme, or with theme to override specific settings.

after_item_idstring

before_item_idstring

Place the new item immediately before this existing item.

order_keynumber

Optional explicit ordering position. Defaults to appending at the end.

Example

{
  "name": "example-string",
  "type": "line_item",
  "after_item_id": "example-string",
  "before_item_id": "example-string",
  "columns": [
    {
      "name": "example-string",
      "description": "example-string",
      "design": {
        "background": "example-string",
        "borderColor": "example-string",
        "borderRadius": 100,
        "borderWidth": 100,
        "buttonColor": "example-string",
        "buttonTextColor": "example-string",
        "checkmarkColor": "example-string",
        "fontColor": "example-string",
        "priceColor": "example-string",
        "quantityBackgroundColor": "example-string",
        "quantityFontColor": "example-string",
        "titleColor": "example-string"
      },
      "feeType": "fixed",
      "frequency": "example-string",
      "includedFeatures": [
        "example-string"
      ],
      "isSelected": true,
      "price": 499
    }
  ],
  "description": "example-string",
  "design": {
    "columns": [
      {}
    ],
    "container": {
      "background": "example-string",
      "borderColor": "example-string",
      "borderWidth": 100,
      "fontColor": "example-string",
      "selectionOutlineColor": "example-string",
      "showHeader": true,
      "sizeModifier": "compact"
    },
    "featuresColumn": {
      "background": "example-string",
      "borderColor": "example-string",
      "borderRadius": 100,
      "borderWidth": 100,
      "fontColor": "example-string"
    },
    "heading": {
      "alignment": "left",
      "background": "example-string",
      "fontColor": "example-string"
    }
  },
  "features": [
    {
      "name": "example-string",
      "order_key": 100
    }
  ],
  "optional": true,
  "order_key": 100,
  "price": {
    "frequency": "once",
    "model": "fixed",
    "quantity": {
      "current": 100,
      "max": 100,
      "min": 100,
      "unitLabel": "example-string"
    },
    "value": 379
  },
  "scope_of_work_page_id": "example-string",
  "selected": true,
  "selection_type": "single",
  "style": "standard",
  "tags": [
    "example-string"
  ],
  "target_group_id": "example-string",
  "theme": "metals"
}

Responses

201Item created.

dataobject

idstring

namestring

order_keynumber

typestring

successboolean

Example

{
  "data": {
    "id": "example-string",
    "name": "example-string",
    "order_key": 100,
    "type": "example-string"
  },
  "success": true
}

400Invalid request (bad type, missing/invalid fields, or no valid parent).

403Not authorized to edit the proposal.

404Proposal (or referenced parent/position item) not found.

Modifications(11)

GET/items/{id}

GetItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

200The item, including parent_id, children, and childCount.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found

errorstring

Example

{
  "error": "Item not found"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/items/{id}

DeleteItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item deleted. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to delete from this proposal.

404Item not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/archive

ArchiveItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item archived. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/duplicate

DuplicateItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification to copy, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

namestring

includeModifiersboolean

Also copy the line item's modifications.

orderKeynumber

Position for the copy. Default is right after the original.

proposalIdstring

Public ID of the destination proposal, to copy into another proposal.

parent_item_idstring

With proposalId. Public ID of the destination group (for a line item) or Scope of Work page (for a side-by-side).

toLibraryboolean

Save a copy to your organization's library instead.

tagsarray of string

With toLibrary. Tags for the library copy.

toItemstring

Public ID of an existing item to overwrite with this item's content (the "update from" action). No new item is created.

Example

{
  "includeModifiers": true,
  "name": "Frontend Development - Copy",
  "orderKey": 100,
  "parent_item_id": "example-string",
  "proposalId": "aB3dE5fG7hJ9",
  "tags": [
    "example-string"
  ],
  "toItem": "example-string",
  "toLibrary": true
}

Responses

201Copy created. item.id is the Public ID of the copy.

itemLineItem

Example

{
  "item": {
    "children": [
      {
        "discountExempt": true,
        "id": "example-string",
        "isOptional": true,
        "isSelected": true,
        "markupExempt": true,
        "name": "example-string",
        "price": {
          "model": "fixed",
          "isRange": true,
          "maxValue": 100,
          "value": 100
        },
        "taxExempt": true,
        "archived_at": "example-string",
        "created_at": "example-string",
        "description": "example-string",
        "discount": {
          "added": true,
          "amount": 100,
          "isSelected": true,
          "scope": "unit",
          "type": "percentage"
        },
        "externalItemId": "example-string",
        "hidden": true,
        "integrations": {
          "quickbooks": {
            "productId": "example-string"
          }
        },
        "internalCost": {
          "amount": 100
        },
        "internalNotes": "example-string",
        "is_archived": true,
        "kind": "mod",
        "label": "example-string",
        "locked": true,
        "outOfPocket": {
          "amount": 100,
          "frequency": "once",
          "label": "example-string"
        },
        "requireSelection": true,
        "selectionType": "single",
        "showCents": true,
        "skipRounding": true,
        "terms": "example-string",
        "updated_at": "example-string"
      }
    ],
    "description": "example-string",
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "childCount": 100,
    "created_at": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hasLinkedItems": true,
    "hidden": true,
    "hideModifications": true,
    "in_library": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "label": "example-string",
    "linkedLibraryItemId": "example-string",
    "locked": true,
    "modificationsLabel": "example-string",
    "order_key": 100,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "parent_id": "example-string",
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "startExpanded": true,
    "tags": [
      "example-string"
    ],
    "terms": "example-string",
    "updated_at": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Line item, destination proposal, or destination parent not found.

409The source proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/items/{id}/items

ListModifications

Return the modifications (add-ons, upsells, options, discounts, markups) and dividers under one line item, in order. Each entry includes its Public ID (id) and its current price; for fixed prices, price.value is in dollars, not cents. Archived and deleted modifications are not included. Use a returned id with UpdateModification to change a modification's price.

Path Parameters

idstringrequired

Public ID of the parent line item, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Query Parameters

limitinteger

Default: 20. Number of modifications per page (max 100).

orderenum

ascdefaultdesc

Sort order

pageinteger

Default: 1. Page number for pagination

searchstring

Search term to filter modifications by name

sortenum

order_keydefaultnamecreated_atupdated_at

Field to sort by

Responses

200Modifications retrieved successfully

dataarray of Modification

Array of modifications

archived_atnullable string

When the modification was archived (ISO 8601 timestamp), or null if active

created_atstring

When the modification was created (ISO 8601 timestamp)

descriptionstring

HTML description of the modification

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update. Pass null to clear.

discountExemptboolean

Whether this modification is exempt from percentage-based scope discounts

externalItemIdnullable string

hiddenboolean

Hidden from the client (same meaning as line-item hidden)

idstring

Unique identifier for the modification

integrationsobject

Integration-specific data

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

is_archivedboolean

Whether this modification is archived

isOptionalboolean

Whether this modification is optional

isSelectedboolean

Whether this modification is currently selected

kindenum

Item kind - 'mod' for regular modifications, 'mod_divider' for dividers

modmod_divider

labelstring

Custom label for the modification

lockedboolean

Logic lock — not in totals, not writable

markupExemptboolean

Whether this modification is exempt from markup calculations

namestring

Name of the modification

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

pricePriceConfig

Price configuration

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification under this divider

selectionTypeenum

Selection type for dividers - affects modifications below the divider

singlemultipleloose

showCentsboolean

Show cents on this modification. Only used when `skipRounding` is true.

skipRoundingboolean

Skip Use Rounded Amounts for this modification. Ignored unless that pricing table has Use Rounded Amounts on.

taxExemptboolean

Whether this modification is exempt from tax calculations

termsstring

HTML added to [dynamic_terms] when this modification qualifies. Gated by the dynamic_terms add-on.

updated_atstring

When the modification was last updated (ISO 8601 timestamp)

paginationobject

Pagination information

Example

{
  "data": [
    {
      "discountExempt": true,
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "markupExempt": true,
      "name": "example-string",
      "price": {
        "frequency": "once",
        "model": "fixed",
        "discount": {},
        "isRange": true,
        "maxValue": 100,
        "quantity": {},
        "value": 100
      },
      "taxExempt": true,
      "archived_at": "example-string",
      "created_at": "example-string",
      "description": "example-string",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "externalItemId": "example-string",
      "hidden": true,
      "integrations": {
        "quickbooks": {
          "productId": "example-string"
        }
      },
      "internalCost": {
        "amount": 100
      },
      "internalNotes": "example-string",
      "is_archived": true,
      "kind": "mod",
      "label": "example-string",
      "locked": true,
      "outOfPocket": {
        "amount": 100,
        "frequency": "once",
        "label": "example-string"
      },
      "requireSelection": true,
      "selectionType": "single",
      "showCents": true,
      "skipRounding": true,
      "terms": "example-string",
      "updated_at": "example-string"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "page": 1,
    "pages": 1,
    "total": 5
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Line item not found.

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/modification

CreateModification

Add a modification (an add-on, upsell, option, discount, or markup) to an existing line item. Only name is required. Pricing uses the same price object as line items. If you omit price, the modification is a fixed $0 one-time price. On create, the price fields you send are merged over the defaults (model fixed, value 0, frequency once). For fixed, value is the unit price in dollars (major currency units), not cents. A negative fixed value is a discount. For percent, value is a whole-number percent (10 = 10%) and price.percentageApplyTo says what it is a percent of (line, group, or scope). Example $250 add-on: { "name": "Rush delivery", "price": { "model": "fixed", "value": 250, "frequency": "once" }, "isOptional": true }. Example 10% discount on the parent line item: { "name": "Loyalty discount", "price": { "model": "percent", "value": -10, "frequency": "once", "percentageApplyTo": "line" } }. A modification's quantity multiplies with its parent line item's quantity. Leave price.quantity out (or at 1) for an add-on that applies once per parent unit. Pass kind mod_divider to add a divider instead: a label with no price whose selectionType controls the modifications listed below it. To change the price later, use UpdateModification. Proposals that are pending signature, won, or lost cannot be edited (409).

Path Parameters

idstringrequired

Public ID of the parent line item, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

namestringrequired

Modification name (1 to 255 characters).

descriptionstring

HTML description shown under the name.

priceobject

Price of the modification. Defaults to { "model": "fixed", "value": 0, "frequency": "once" }; fields you send override those defaults.

isOptionalboolean

Whether the client can toggle the modification on and off.

isSelectedboolean

Whether an optional modification starts selected.

labelstring

Text shown instead of a price when price.model is text (for example "TBD").

taxExemptboolean

Exclude from sales tax.

markupExemptboolean

Exclude from proposal markup.

discountExemptboolean

Exclude from proposal-wide percentage discounts.

externalItemIdstring

Your own identifier (SKU, CRM id). Shown in the editor as "Item ID". Printable characters, including spaces and punctuation; max 255. Control characters and non-ASCII are not allowed.

order_keynumber

Position among the line item's modifications. Defaults to the end.

kindenum

mod (default) for a priced modification. mod_divider for a divider with no price; price fields are ignored.

modmod_divider

selectionTypeenum

Only for kind mod_divider. How the modifications below the divider can be picked: single (one), multiple (several), or loose (each independently optional).

singlemultipleloose

requireSelectionboolean

Only for kind mod_divider with selectionType loose. The client must pick at least one modification below it.

Example

{
  "name": "Rush delivery",
  "description": "<p>Delivered within 48 hours.</p>",
  "discountExempt": true,
  "externalItemId": "example-string",
  "isOptional": true,
  "isSelected": true,
  "kind": "mod",
  "label": "example-string",
  "markupExempt": true,
  "order_key": 1,
  "price": {
    "frequency": "once",
    "model": "fixed",
    "percentageApplyTo": "line",
    "quantity": {
      "current": 100,
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "unitLabel": "example-string"
    },
    "value": 250
  },
  "requireSelection": true,
  "selectionType": "single",
  "taxExempt": true
}

Responses

201Modification created.

dataobject

The new modification, including its price.

idstring

Public ID of the new modification.

kindstring

namestring

Example

{
  "data": {
    "id": "zw5FD5HGcfE3",
    "kind": "mod",
    "name": "example-string"
  }
}

400Validation error (for example an empty name or an invalid price.model).

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Line item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/items/{id}/modifications/{modificationId}

GetModification

Return one modification of a line item, including its price. Both path values are Public IDs returned by the API (for example zw5FD5HGcfE3): {id} is the parent line item and {modificationId} is the modification. Neither is the editor field labeled "Item ID"; that field is externalItemId on the modification.

Path Parameters

idstringrequired

Public ID of the parent line item (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

modificationIdstringrequired

Public ID of the modification (for example kP3mNq8rT2xY). Not the editor "Item ID" (externalItemId).

e.g., kP3mNq8rT2xY

Responses

200The modification.

dataobject

created_atstring

descriptionstring

HTML description.

discountExemptboolean

externalItemIdstring

Your own identifier, shown in the editor as "Item ID".

idstring

Public ID of the modification.

isOptionalboolean

isSelectedboolean

labelstring

Text shown instead of a price when price.model is text.

markupExemptboolean

namestring

parent_idstring

Public ID of the parent line item.

priceobject

Current price. For fixed, value is in dollars (not cents). For percent, value is a whole-number percent (10 = 10%).

taxExemptboolean

updated_atstring

Example

{
  "data": {
    "created_at": "2024-01-20T15:30:00Z",
    "description": "<p>Delivered within 48 hours.</p>",
    "discountExempt": true,
    "externalItemId": "example-string",
    "id": "kP3mNq8rT2xY",
    "isOptional": true,
    "isSelected": true,
    "label": "example-string",
    "markupExempt": true,
    "name": "Rush delivery",
    "parent_id": "example-string",
    "price": {
      "discount": {},
      "frequency": "once",
      "isRange": true,
      "maxValue": 100,
      "model": "fixed",
      "percentageApplyTo": "line",
      "quantity": {},
      "value": 250
    },
    "taxExempt": true,
    "updated_at": "2024-01-20T15:30:00Z"
  }
}

400The item is not a modification, or it does not belong to the line item in {id}.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Modification or parent line item not found.

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Modification not found"
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/items/{id}/modifications/{modificationId}

UpdateModification

Change an existing modification in place. You can change its price: send price with model, value, and frequency together. price replaces the existing price (range fields such as maxValue and isRange that you leave out are cleared; price.quantity changes only when you send it). For fixed, value is the unit price in dollars (major currency units), not cents. A negative fixed value makes the modification a discount. Sending only { "price": { "value": 1500 } } does not update the price; model is required. For percent, value is a whole-number percent (10 = 10%) and percentageApplyTo says what it is a percent of. Example that sets the price to $1,500 per month: { "price": { "model": "fixed", "value": 1500, "frequency": "monthly" } }. Example $200 discount: { "price": { "model": "fixed", "value": -200, "frequency": "once" } }. Other fields (name, description, isOptional, isSelected, exemptions, externalItemId) change only when you send them. The body is flat, with no "item" wrapper. PATCH /api/items/{modificationId} accepts the same body. Both path values are Public IDs returned by the API (for example zw5FD5HGcfE3), not the editor field labeled "Item ID". To set that field, send externalItemId (printable characters, including spaces and punctuation; max 255; control characters and non-ASCII are not allowed; null or "" clears it). Proposals that are pending signature, won, or lost cannot be edited (409 PROPOSAL_LOCKED). The same applies when the customer-visible version of a versioned proposal is locked.

Path Parameters

idstringrequired

Public ID of the parent line item (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

modificationIdstringrequired

Public ID of the modification (for example kP3mNq8rT2xY). Not the editor "Item ID" (externalItemId).

e.g., kP3mNq8rT2xY

Request Body

namestring

Modification name. Cannot be empty.

descriptionstring

HTML description.

priceobject

New price. Replaces the existing price. Send model, value, and frequency together; value without model is ignored. quantity is kept unless you send it.

isOptionalboolean

Whether the client can toggle the modification on and off.

isSelectedboolean

Whether the modification is selected.

taxExemptboolean

Exclude from sales tax.

markupExemptboolean

Exclude from proposal markup.

discountExemptboolean

Exclude from proposal-wide percentage discounts.

labelstring

Text shown instead of a price when price.model is text (for example "TBD").

externalItemIdstring

Your own identifier (SKU, CRM id), shown in the editor as "Item ID". Printable characters, including spaces and punctuation; max 255. Control characters and non-ASCII are not allowed. null or "" clears it.

Example

{
  "description": "<p>Delivered within 48 hours.</p>",
  "discountExempt": true,
  "externalItemId": "example-string",
  "isOptional": true,
  "isSelected": true,
  "label": "example-string",
  "markupExempt": true,
  "name": "Rush delivery",
  "price": {
    "frequency": "once",
    "model": "fixed",
    "discount": {},
    "isRange": true,
    "maxValue": 100,
    "percentageApplyTo": "line",
    "quantity": {},
    "value": 1500
  },
  "taxExempt": true
}

Responses

200Modification updated. Returns the modification as it is now stored, including its price.

dataobject

idstring

Public ID of the modification.

namestring

parent_idstring

Public ID of the parent line item.

priceobject

Example

{
  "data": {
    "id": "kP3mNq8rT2xY",
    "name": "example-string",
    "parent_id": "example-string",
    "price": {}
  }
}

400Validation error (for example an invalid price.model or frequency), or the modification does not belong to the line item in {id}.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to edit this proposal.

404Modification or parent line item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/move

MoveItem

Path Parameters

idstringrequired

Public ID of the line item, side-by-side, or modification to move, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Request Body

after_idstringrequired

Required (may be null). Public ID of the sibling to place this object after, or (for a line item) Public ID of a group to place it first in that group. null places it first under its current parent.

Example

{
  "after_id": "ijklmnop5678"
}

Responses

200Object moved.

dataobject

idstring

Public ID of the moved object.

Example

{
  "data": {
    "id": "zw5FD5HGcfE3"
  }
}

400after_id is missing from the body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Object (or the after_id target) not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/items/{id}/unarchive

UnarchiveItem

Path Parameters

idstringrequired

Public ID of the archived line item, side-by-side, or modification, as returned by the API (for example zw5FD5HGcfE3). Not the editor "Item ID" (externalItemId).

e.g., zw5FD5HGcfE3

Responses

204Item restored. No response body.

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Item not found.

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/proposals/{id}/items/{itemId}/modifications

UpdateProposalItemModifications

Save the complete list of modifications for one line item in a single call. The body is a JSON array, and the result matches it exactly: - An entry whose id is the Public ID of an existing modification on this line item overwrites that modification. - An entry with no id (or an id that is not on this line item) is created as a new modification. - Existing modifications that are not in the array are archived. Sending an empty array archives all of them. - The array order becomes the display order. Send every entry in full. Fields you leave out are not kept from the stored modification; they fall back to defaults: price becomes fixed $0 one-time, isOptional false, isSelected true, and quantity is removed. For fixed prices, price.value is in dollars (major currency units), not cents; a negative value is a discount. For percent, price.value is a whole-number percent (10 = 10%) and percentageApplyTo defaults to line. Example: [ { "id": "kP3mNq8rT2xY", "name": "Rush delivery", "isOptional": true, "price": { "model": "fixed", "value": 250, "frequency": "once" } }, { "name": "Extended warranty", "isOptional": true, "price": { "model": "fixed", "value": 99, "frequency": "annually" } } ]. To change one modification without resending the rest, use UpdateModification instead. Proposals that are pending signature, won, or lost cannot be edited (409 PROPOSAL_LOCKED), and neither can a locked customer version.

Path Parameters

idstringrequired

Public ID of the proposal (for example zw5FD5HGcfE3).

e.g., zw5FD5HGcfE3

itemIdstringrequired

Public ID of the line item whose modifications you are replacing (for example kP3mNq8rT2xY). It must belong to the proposal in {id}. Not the editor "Item ID" (externalItemId).

e.g., kP3mNq8rT2xY

Request Body

array<

idstringrequired

Unique identifier for the modification

namestringrequired

Name of the modification

pricePriceConfigrequired

Price configuration

isOptionalbooleanrequired

Whether this modification is optional

isSelectedbooleanrequired

Whether this modification is currently selected

taxExemptbooleanrequired

Whether this modification is exempt from tax calculations

markupExemptbooleanrequired

Whether this modification is exempt from markup calculations

discountExemptbooleanrequired

Whether this modification is exempt from percentage-based scope discounts

descriptionstring

HTML description of the modification

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

termsstring

HTML added to [dynamic_terms] when this modification qualifies. Gated by the dynamic_terms add-on.

hiddenboolean

Hidden from the client (same meaning as line-item hidden)

lockedboolean

Logic lock — not in totals, not writable

skipRoundingboolean

Skip Use Rounded Amounts for this modification. Ignored unless that pricing table has Use Rounded Amounts on.

showCentsboolean

Show cents on this modification. Only used when `skipRounding` is true.

labelstring

Custom label for the modification

kindenum

Item kind - 'mod' for regular modifications, 'mod_divider' for dividers

modmod_divider

selectionTypeenum

Selection type for dividers - affects modifications below the divider

singlemultipleloose

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification under this divider

integrationsobject

Integration-specific data

externalItemIdnullable string

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update. Pass null to clear.

created_atstring

When the modification was created (ISO 8601 timestamp)

updated_atstring

When the modification was last updated (ISO 8601 timestamp)

archived_atnullable string

When the modification was archived (ISO 8601 timestamp), or null if active

is_archivedboolean

Whether this modification is archived

Example

[
  {
    "discountExempt": true,
    "id": "example-string",
    "isOptional": true,
    "isSelected": true,
    "markupExempt": true,
    "name": "example-string",
    "price": {
      "frequency": "once",
      "model": "fixed",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "isRange": true,
      "maxValue": 100,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "volumePricingEnabled": true,
        "volumeTiers": []
      },
      "value": 100
    },
    "taxExempt": true,
    "archived_at": "example-string",
    "created_at": "example-string",
    "description": "example-string",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "externalItemId": "example-string",
    "hidden": true,
    "integrations": {
      "quickbooks": {
        "productId": "example-string"
      }
    },
    "internalCost": {
      "amount": 100
    },
    "internalNotes": "example-string",
    "is_archived": true,
    "kind": "mod",
    "label": "example-string",
    "locked": true,
    "outOfPocket": {
      "amount": 100,
      "frequency": "once",
      "label": "example-string"
    },
    "requireSelection": true,
    "selectionType": "single",
    "showCents": true,
    "skipRounding": true,
    "terms": "example-string",
    "updated_at": "example-string"
  }
]

Responses

204Modifications saved. No response body. Read them back with ListModifications.

400Validation error (for example an invalid externalItemId or a field from an add-on that is turned off).

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to edit this proposal.

404Proposal not found, or the line item is not in this proposal.

errorstring

Example

{
  "error": "Item not found"
}

409The proposal is locked (pending signature, won, lost, or a locked customer version).

500Failed to save modifications.

errorstring

Example

{
  "error": "Failed to insert modifications"
}

Schemas

Price Configuration

Frequency

Used by: PriceConfig.anyOf[0].frequency·PriceConfig.anyOf[4].frequency·OutOfPocketConfig.frequency·PriceConfig.anyOf[1].frequency·PriceConfig.anyOf[2].frequency

Billing frequency for recurring items

Enum values:

onceOne-time only

weeklyOnce a week

biweeklyOnce every two weeks

monthlyOnce a month

semi-monthlyTwice a month

quarterlyOnce every 3 months

semi-annuallyTwice a year

annuallyOnce a year

every-2-yearsOnce every 2 years

every-3-yearsOnce every 3 years

every-4-yearsOnce every 4 years

every-5-yearsOnce every 5 years

every-6-yearsOnce every 6 years

every-7-yearsOnce every 7 years

every-8-yearsOnce every 8 years

every-9-yearsOnce every 9 years

every-10-yearsOnce every 10 years

Example

"once"

LineItemDiscountConfig

Used by: CreateItem.discount.anyOf[0]·PriceConfig.anyOf[0].discount.anyOf[0]·PriceConfig.anyOf[4].discount.anyOf[0]·LineItem.discount.anyOf[0]·Modification.discount.anyOf[0]·PriceConfig.anyOf[3].discount.anyOf[0]·PriceConfig.anyOf[1].discount.anyOf[0]·PriceConfig.anyOf[2].discount.anyOf[0]·UpdateLineItemApiInput.discount.anyOf[0]

Configuration for discounts applied to line items

addedboolean

Whether the discount has been added. Defaults to true on write when omitted.

isSelectedboolean

Whether the discount is currently selected/applied. Defaults to true on write when omitted.

scopeenum

Scope of the discount. `unit` = per quantity; `total` (also accepted as `line`) = the whole line. `group` / `scope` are accepted aliases for total-style discounts.

unittotallinegroupscope

typeenum

Discount type: 'percentage' or 'fixed' amount

percentagefixed

amountnumber

Discount amount. For type="percentage" this is a whole-number percent (10 = 10%). For type="fixed" this is dollars (not cents).

Example

{
  "added": true,
  "amount": 100,
  "isSelected": true,
  "scope": "unit",
  "type": "percentage"
}

PriceConfig

Used by: CreateItem.price·LineItem.price·Modification.price·UpdateLineItemApiInput.price

Price configuration - discriminated union of pricing models The 'model' field determines which configuration type is used

Example

{
  "frequency": "once",
  "model": "fixed",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "isRange": true,
  "maxValue": 100,
  "quantity": {
    "editableByRecipient": true,
    "max": 100,
    "min": 100,
    "current": 100,
    "unitLabel": "example-string",
    "volumePricingEnabled": true,
    "volumeTiers": [
      {
        "unitPrice": 100,
        "upTo": 100
      }
    ]
  },
  "value": 100
}

QuantityConfig3 required

Used by: CreateGroup.quantity·PriceConfig.anyOf[0].quantity.anyOf[0]·PriceConfig.anyOf[4].quantity.anyOf[0]·PriceConfig.anyOf[3].quantity.anyOf[0]·PageChild.anyOf[0].quantity·PriceConfig.anyOf[1].quantity.anyOf[0]·GetGroup.quantity·PriceConfig.anyOf[2].quantity.anyOf[0]·UpdateGroup.quantity

Configuration for item quantity settings

minnumberrequired

Minimum quantity allowed

maxnumberrequired

Maximum quantity allowed

editableByRecipientbooleanrequired

Whether the recipient can edit the quantity

currentnumber

Current quantity value

unitLabelunion

Unit label. A string is automatically singularized/pluralized. An object supplies explicit singular and plural forms (both required).

volumePricingEnabledboolean

When true, unit price is selected from volumeTiers based on current quantity (volume pricing). Only valid for fixed (non-range) line items and modifications.

volumeTiersarray of object

Ordered volume pricing tiers (used when volumePricingEnabled is true)

Example

{
  "editableByRecipient": true,
  "max": 100,
  "min": 100,
  "current": 100,
  "unitLabel": "example-string",
  "volumePricingEnabled": true,
  "volumeTiers": [
    {
      "unitPrice": 100,
      "upTo": 100
    }
  ]
}

Item Types

LineItem10 required

Used by: ListItems (response 200)·GetItem (response 200)·GetItem (response 200)·GetItem (response 200)·ListLibraryItems (response 200)·CreateItem (response 201)·DuplicateItem (response 201)·DuplicateItem (response 201)·DuplicateItem (response 201)·UpdateItem (response 200)·UpdateItem (response 200)·PageChild.anyOf[0].lineItems.[]·GetGroup.lineItems.[]

A line item (product or service) within a group

idstringrequired

Unique line item identifier

namestringrequired

Line item name/title

descriptionstringrequired

HTML content for the item description

pricePriceConfigrequired

isOptionalbooleanrequired

Whether this line item is optional for the client

isSelectedbooleanrequired

Whether this optional item is currently selected

taxExemptbooleanrequired

Whether this item is exempt from sales tax

markupExemptbooleanrequired

Whether this item is exempt from markup

discountExemptbooleanrequired

Whether this item is exempt from proposal-wide percentage discounts

childrenarray of Modificationrequired

Array of child modifications/options for this line item

skipRoundingboolean

Skip Use Rounded Amounts for this item. Ignored unless that pricing table has Use Rounded Amounts on. `showCents` then shows cents on this item only.

showCentsboolean

Show cents on this item. Only used when `skipRounding` is true.

hiddenboolean

Whether this item is hidden from the client view

lockedboolean

Logic lock. Hidden always implies locked. Locked items are not in totals and cannot be changed except by the engine.

hideModificationsboolean

Whether to hide modifications/options for this item

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

termsstring

HTML added to [dynamic_terms] when this line item qualifies. Gated by the dynamic_terms add-on.

modificationsLabelstring

Custom label for the modifications section (e.g., "Options", "Add-ons")

startExpandedboolean

Whether modifications are expanded by default

order_keynumber

Sort position within the group

selectionTypeenum

How child modifications can be selected (single, multiple, etc.)

singlemultipleloose

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification (ignored when hideModifications is true)

labelstring

Custom display label for this line item

tagsarray of string

Tags/labels applied to this item

integrationsobject

External integration references for this item

externalItemIdnullable string

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update so Discount can be set without nesting. Pass null to clear.

created_atstring

When the item was created (ISO 8601 timestamp)

updated_atstring

When the item was last updated (ISO 8601 timestamp)

archived_atnullable string

When the item was archived (ISO 8601 timestamp), or null if active

is_archivedboolean

Whether the item is archived

childCountnumber

Number of child modifications

parent_idnullable string

The public_id of the parent group or scope that this item belongs to

in_libraryboolean

Whether this item belongs to the library (true) or a regular proposal (false/undefined)

linkedLibraryItemIdnullable string

Public ID of the library item this is linked to (templates only)

hasLinkedItemsboolean

Whether this library item has other items linked to it (library items only)

Example

{
  "children": [
    {
      "discountExempt": true,
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "markupExempt": true,
      "name": "example-string",
      "price": {
        "frequency": "once",
        "model": "fixed",
        "discount": {},
        "isRange": true,
        "maxValue": 100,
        "quantity": {},
        "value": 100
      },
      "taxExempt": true,
      "archived_at": "example-string",
      "created_at": "example-string",
      "description": "example-string",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "externalItemId": "example-string",
      "hidden": true,
      "integrations": {
        "quickbooks": {
          "productId": "example-string"
        }
      },
      "internalCost": {
        "amount": 100
      },
      "internalNotes": "example-string",
      "is_archived": true,
      "kind": "mod",
      "label": "example-string",
      "locked": true,
      "outOfPocket": {
        "amount": 100,
        "frequency": "once",
        "label": "example-string"
      },
      "requireSelection": true,
      "selectionType": "single",
      "showCents": true,
      "skipRounding": true,
      "terms": "example-string",
      "updated_at": "example-string"
    }
  ],
  "description": "example-string",
  "discountExempt": true,
  "id": "example-string",
  "isOptional": true,
  "isSelected": true,
  "markupExempt": true,
  "name": "example-string",
  "price": {
    "frequency": "once",
    "model": "fixed",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "isRange": true,
    "maxValue": 100,
    "quantity": {
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "current": 100,
      "unitLabel": "example-string",
      "volumePricingEnabled": true,
      "volumeTiers": [
        {}
      ]
    },
    "value": 100
  },
  "taxExempt": true,
  "archived_at": "example-string",
  "childCount": 100,
  "created_at": "example-string",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "externalItemId": "example-string",
  "hasLinkedItems": true,
  "hidden": true,
  "hideModifications": true,
  "in_library": true,
  "integrations": {
    "quickbooks": {
      "productId": "example-string"
    }
  },
  "internalCost": {
    "amount": 100
  },
  "internalNotes": "example-string",
  "is_archived": true,
  "label": "example-string",
  "linkedLibraryItemId": "example-string",
  "locked": true,
  "modificationsLabel": "example-string",
  "order_key": 100,
  "outOfPocket": {
    "amount": 100,
    "frequency": "once",
    "label": "example-string"
  },
  "parent_id": "example-string",
  "requireSelection": true,
  "selectionType": "single",
  "showCents": true,
  "skipRounding": true,
  "startExpanded": true,
  "tags": [
    "example-string"
  ],
  "terms": "example-string",
  "updated_at": "example-string"
}

UpdateLineItemApiInput

Used by: UpdateItem (request)·UpdateItem (request)

Request body for updating a line item or modification (PATCH /api/items/{id}). All fields are optional; only the fields you send change. The body is flat (no `item` wrapper). `price` is a full replacement: to change the cost, send the whole price object with `model`, `value` (dollars, not cents), and `frequency`, e.g. `{ "price": { "model": "fixed", "value": 379, "frequency": "once" } }`.

pricePriceConfig

New price. This is how you change the cost of an existing line item or modification. It replaces the whole price: send `model`, `value`, and `frequency` together. For fixed, `value` is the unit price in dollars (major currency units), not cents. For percent, `value` is a whole-number percent (15 = 15%). Sending only `value` without `model` does not change the price. Example: `{ "model": "fixed", "value": 379, "frequency": "once" }`.

internal_costnullable InternalCostConfig

Alias for `internalCost` (snake_case).

namestring

Line item name/title

descriptionstring

HTML content for the item description

isOptionalboolean

Whether this line item is optional for the client

isSelectedboolean

Whether this optional item is currently selected

taxExemptboolean

Whether this item is exempt from sales tax

markupExemptboolean

Whether this item is exempt from markup

discountExemptboolean

Whether this item is exempt from proposal-wide percentage discounts

skipRoundingboolean

Skip Use Rounded Amounts for this item. Ignored unless that pricing table has Use Rounded Amounts on. `showCents` then shows cents on this item only.

showCentsboolean

Show cents on this item. Only used when `skipRounding` is true.

hiddenboolean

Whether this item is hidden from the client view

lockedboolean

Logic lock. Hidden always implies locked. Locked items are not in totals and cannot be changed except by the engine.

hideModificationsboolean

Whether to hide modifications/options for this item

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

termsstring

HTML added to [dynamic_terms] when this line item qualifies. Gated by the dynamic_terms add-on.

modificationsLabelstring

Custom label for the modifications section (e.g., "Options", "Add-ons")

startExpandedboolean

Whether modifications are expanded by default

order_keynumber

Sort position within the group

selectionTypeenum

How child modifications can be selected (single, multiple, etc.)

singlemultipleloose

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification (ignored when hideModifications is true)

labelstring

Custom display label for this line item

tagsarray of string

Tags/labels applied to this item

integrationsobject

External integration references for this item

externalItemIdnullable string

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update so Discount can be set without nesting. Pass null to clear.

parent_idnullable string

The public_id of the parent group or scope that this item belongs to

in_libraryboolean

Whether this item belongs to the library (true) or a regular proposal (false/undefined)

linkedLibraryItemIdnullable string

Public ID of the library item this is linked to (templates only)

hasLinkedItemsboolean

Whether this library item has other items linked to it (library items only)

Example

{
  "description": "example-string",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "discountExempt": true,
  "externalItemId": "example-string",
  "hasLinkedItems": true,
  "hidden": true,
  "hideModifications": true,
  "in_library": true,
  "integrations": {
    "quickbooks": {
      "productId": "example-string"
    }
  },
  "internal_cost": {
    "amount": 100
  },
  "internalCost": {
    "amount": 100
  },
  "internalNotes": "example-string",
  "isOptional": true,
  "isSelected": true,
  "label": "example-string",
  "linkedLibraryItemId": "example-string",
  "locked": true,
  "markupExempt": true,
  "modificationsLabel": "example-string",
  "name": "example-string",
  "order_key": 100,
  "outOfPocket": {
    "amount": 100,
    "frequency": "once",
    "label": "example-string"
  },
  "parent_id": "example-string",
  "price": {
    "frequency": "once",
    "model": "fixed",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "isRange": true,
    "maxValue": 100,
    "quantity": {
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "current": 100,
      "unitLabel": "example-string",
      "volumePricingEnabled": true,
      "volumeTiers": [
        {}
      ]
    },
    "value": 100
  },
  "requireSelection": true,
  "selectionType": "single",
  "showCents": true,
  "skipRounding": true,
  "startExpanded": true,
  "tags": [
    "example-string"
  ],
  "taxExempt": true,
  "terms": "example-string"
}

Modification Types

Modification8 required

Used by: ListModifications (response 200)·UpdateProposalItemModifications (request)·CreateItem.children.[]·LineItem.children.[]

A modification (child item) of a line item - represents an option or variant

idstringrequired

Unique identifier for the modification

namestringrequired

Name of the modification

pricePriceConfigrequired

Price configuration

isOptionalbooleanrequired

Whether this modification is optional

isSelectedbooleanrequired

Whether this modification is currently selected

taxExemptbooleanrequired

Whether this modification is exempt from tax calculations

markupExemptbooleanrequired

Whether this modification is exempt from markup calculations

discountExemptbooleanrequired

Whether this modification is exempt from percentage-based scope discounts

descriptionstring

HTML description of the modification

internalNotesstring

Admin-only internal notes (never shown to recipients unless Configure PDF includes them)

termsstring

HTML added to [dynamic_terms] when this modification qualifies. Gated by the dynamic_terms add-on.

hiddenboolean

Hidden from the client (same meaning as line-item hidden)

lockedboolean

Logic lock — not in totals, not writable

skipRoundingboolean

Skip Use Rounded Amounts for this modification. Ignored unless that pricing table has Use Rounded Amounts on.

showCentsboolean

Show cents on this modification. Only used when `skipRounding` is true.

labelstring

Custom label for the modification

kindenum

Item kind - 'mod' for regular modifications, 'mod_divider' for dividers

modmod_divider

selectionTypeenum

Selection type for dividers - affects modifications below the divider

singlemultipleloose

requireSelectionboolean

When selectionType is loose, require the customer to select at least one modification under this divider

integrationsobject

Integration-specific data

externalItemIdnullable string

outOfPocketnullable OutOfPocketConfig

Fixed out-of-pocket (pass-through) amount billed to the client. Gated by the out_of_pocket_costs module. Not marked up or taxed.

internalCostnullable InternalCostConfig

What you pay (per unit when quantity applies). Editor-only. Writable on create/update as `internalCost` or `internal_cost`. Gated by the profit_margins module. Never shown to customers.

discountnullable LineItemDiscountConfig

Per-line discount (same object as `price.discount`). Accepted at the top level on create/update. Pass null to clear.

created_atstring

When the modification was created (ISO 8601 timestamp)

updated_atstring

When the modification was last updated (ISO 8601 timestamp)

archived_atnullable string

When the modification was archived (ISO 8601 timestamp), or null if active

is_archivedboolean

Whether this modification is archived

Example

{
  "discountExempt": true,
  "id": "example-string",
  "isOptional": true,
  "isSelected": true,
  "markupExempt": true,
  "name": "example-string",
  "price": {
    "frequency": "once",
    "model": "fixed",
    "discount": {
      "added": true,
      "amount": 100,
      "isSelected": true,
      "scope": "unit",
      "type": "percentage"
    },
    "isRange": true,
    "maxValue": 100,
    "quantity": {
      "editableByRecipient": true,
      "max": 100,
      "min": 100,
      "current": 100,
      "unitLabel": "example-string",
      "volumePricingEnabled": true,
      "volumeTiers": [
        {}
      ]
    },
    "value": 100
  },
  "taxExempt": true,
  "archived_at": "example-string",
  "created_at": "example-string",
  "description": "example-string",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "externalItemId": "example-string",
  "hidden": true,
  "integrations": {
    "quickbooks": {
      "productId": "example-string"
    }
  },
  "internalCost": {
    "amount": 100
  },
  "internalNotes": "example-string",
  "is_archived": true,
  "kind": "mod",
  "label": "example-string",
  "locked": true,
  "outOfPocket": {
    "amount": 100,
    "frequency": "once",
    "label": "example-string"
  },
  "requireSelection": true,
  "selectionType": "single",
  "showCents": true,
  "skipRounding": true,
  "terms": "example-string",
  "updated_at": "example-string"
}

Page Types

PageChild

Used by: ProposalPage.children.[]·CreatePage.children.[]·UpdatePage.children.[]

Discriminated union for page children (groups and side-by-sides). Both share order_key from the same namespace for interleaved ordering.

Example

{
  "displayCost": "show_all",
  "id": "example-string",
  "isOptional": true,
  "isSelected": true,
  "kind": "group",
  "lineItems": [
    {
      "children": [
        {
          "discountExempt": true,
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "markupExempt": true,
          "name": "example-string",
          "taxExempt": true,
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "discount": {},
          "externalItemId": "example-string",
          "hidden": true,
          "integrations": {
            "quickbooks": {
              "productId": "example-string"
            }
          },
          "internalCost": {},
          "internalNotes": "example-string",
          "is_archived": true,
          "kind": "mod",
          "label": "example-string",
          "locked": true,
          "outOfPocket": {},
          "requireSelection": true,
          "selectionType": "single",
          "showCents": true,
          "skipRounding": true,
          "terms": "example-string",
          "updated_at": "example-string"
        }
      ],
      "description": "example-string",
      "discountExempt": true,
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "markupExempt": true,
      "name": "example-string",
      "price": {
        "frequency": "once",
        "model": "fixed",
        "isRange": true,
        "maxValue": 100,
        "value": 100
      },
      "taxExempt": true,
      "archived_at": "example-string",
      "childCount": 100,
      "created_at": "example-string",
      "discount": {
        "added": true,
        "amount": 100,
        "isSelected": true,
        "scope": "unit",
        "type": "percentage"
      },
      "externalItemId": "example-string",
      "hasLinkedItems": true,
      "hidden": true,
      "hideModifications": true,
      "in_library": true,
      "integrations": {
        "quickbooks": {
          "productId": "example-string"
        }
      },
      "internalCost": {
        "amount": 100
      },
      "internalNotes": "example-string",
      "is_archived": true,
      "label": "example-string",
      "linkedLibraryItemId": "example-string",
      "locked": true,
      "modificationsLabel": "example-string",
      "order_key": 100,
      "outOfPocket": {
        "amount": 100,
        "frequency": "once",
        "label": "example-string"
      },
      "parent_id": "example-string",
      "requireSelection": true,
      "selectionType": "single",
      "showCents": true,
      "skipRounding": true,
      "startExpanded": true,
      "tags": [
        "example-string"
      ],
      "terms": "example-string",
      "updated_at": "example-string"
    }
  ],
  "name": "example-string",
  "selectionType": "single",
  "archived_at": "example-string",
  "created_at": "example-string",
  "description": "example-string",
  "hidden": true,
  "hideQuantities": true,
  "in_library": true,
  "internalNotes": "example-string",
  "is_archived": true,
  "linkedScopeId": "example-string",
  "locked": true,
  "order_key": 100,
  "pdfPageBreak": true,
  "quantity": {
    "editableByRecipient": true,
    "max": 100,
    "min": 100,
    "current": 100,
    "unitLabel": "example-string",
    "volumePricingEnabled": true,
    "volumeTiers": [
      {
        "unitPrice": 100,
        "upTo": 100
      }
    ]
  },
  "requireSelection": true,
  "startExpanded": true,
  "tags": [
    "example-string"
  ],
  "updated_at": "example-string"
}

PageDesignSettings

Used by: ProposalPage.designSettings·CreatePage.designSettings·UpdatePage.designSettings.anyOf[0]

Visual design settings for a specific page

backgroundColorstring

Background color (CSS color value)

fontColorstring

Font/text color (CSS color value)

backgroundImagestring

URL of the background image

backgroundPositionstring

CSS background-position value

backgroundSizestring

CSS background-size value

backgroundRepeatstring

CSS background-repeat value

backgroundAttachmentstring

CSS background-attachment value

backgroundOpacitynumber

Opacity of the background image as a percent from 0 to 100

contentWidthenum

Override proposal-level page content max-width for this page. Omit to inherit from proposal design.styling.content_width.

fullmediumcompactnarrow

contentAlignenum

Override proposal-level content column alignment for this page. Omit to inherit from proposal design.styling.content_align.

leftcenterright

Example

{
  "backgroundAttachment": "example-string",
  "backgroundColor": "example-string",
  "backgroundImage": "example-string",
  "backgroundOpacity": 100,
  "backgroundPosition": "example-string",
  "backgroundRepeat": "example-string",
  "backgroundSize": "example-string",
  "contentAlign": "left",
  "contentWidth": "full",
  "fontColor": "example-string"
}

ProposalPage3 required

Used by: GetPage (response 200)·ListPages (response 200)·CreatePage (response 201)

A page within a proposal. Pages contain the content sections of a proposal.

namestringrequired

Page name/title

contentstringrequired

Rich text content of the page

order_keynumberrequired

Sort position of the page within the proposal

idstring

Unique page identifier

created_atstring

When the page was created (ISO 8601 timestamp)

updated_atstring

When the page was last updated (ISO 8601 timestamp)

kindstring

Type of page (e.g., content, pricing, signatures)

scopeIdstring

ID of the scope of work section this page belongs to

isScopeOfWorkboolean

Whether this page is a scope of work pricing page

isSignaturesPageboolean

Whether this is the signatures page

screenshotUrlnullable string

URL of the page screenshot thumbnail

showCentsboolean

Whether to display cents in price values

useRoundedAmountsboolean

salesTaxPercentagestring

Sales tax percentage applied to this page

lineItemsStartExpandedenum

Whether line items are expanded by default

noneallfirst

selectionTypeenum

How items on this page can be selected

singlemultipleloose

requireSelectionboolean

When selectionType is loose, require the customer to select at least one optional group

tagsarray of string

Tags/labels applied to this page

metadataRecord%3Cstring%2Cunknown%3E

markupPercentagestring

Markup percentage applied to items on this page

discountsarray of object

Discount configurations for this page

hideTotalsTopboolean

Whether to hide the totals row at the top of the page

hideTotalsBottomboolean

Whether to hide the totals row at the bottom of the page

labelsobject

Custom label overrides for this page

displayHeadingboolean

Whether to display the page heading

hideSectionboolean

excludeFromPdfboolean

Whether to exclude this page from PDF exports

startNewPdfPageboolean

When false, this page continues on the same PDF page as the previous one. Omitted/undefined keeps the historical behavior: each page starts a new PDF page.

designSettingsPageDesignSettings

childrenarray of PageChild

Unified ordered list of groups and side-by-sides (only on scope-of-work pages)

Example

{
  "content": "example-string",
  "name": "example-string",
  "order_key": 100,
  "children": [
    {
      "displayCost": "show_all",
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "kind": "group",
      "lineItems": [
        {
          "children": [
            {}
          ],
          "description": "example-string",
          "discountExempt": true,
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "markupExempt": true,
          "name": "example-string",
          "taxExempt": true,
          "archived_at": "example-string",
          "childCount": 100,
          "created_at": "example-string",
          "discount": {},
          "externalItemId": "example-string",
          "hasLinkedItems": true,
          "hidden": true,
          "hideModifications": true,
          "in_library": true,
          "integrations": {
            "quickbooks": {
              "productId": "example-string"
            }
          },
          "internalCost": {},
          "internalNotes": "example-string",
          "is_archived": true,
          "label": "example-string",
          "linkedLibraryItemId": "example-string",
          "locked": true,
          "modificationsLabel": "example-string",
          "order_key": 100,
          "outOfPocket": {},
          "parent_id": "example-string",
          "requireSelection": true,
          "selectionType": "single",
          "showCents": true,
          "skipRounding": true,
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "terms": "example-string",
          "updated_at": "example-string"
        }
      ],
      "name": "example-string",
      "selectionType": "single",
      "archived_at": "example-string",
      "created_at": "example-string",
      "description": "example-string",
      "hidden": true,
      "hideQuantities": true,
      "in_library": true,
      "internalNotes": "example-string",
      "is_archived": true,
      "linkedScopeId": "example-string",
      "locked": true,
      "order_key": 100,
      "pdfPageBreak": true,
      "quantity": {
        "editableByRecipient": true,
        "max": 100,
        "min": 100,
        "current": 100,
        "unitLabel": "example-string",
        "volumePricingEnabled": true,
        "volumeTiers": [
          {
            "unitPrice": 100,
            "upTo": 100
          }
        ]
      },
      "requireSelection": true,
      "startExpanded": true,
      "tags": [
        "example-string"
      ],
      "updated_at": "example-string"
    }
  ],
  "created_at": "example-string",
  "designSettings": {
    "backgroundAttachment": "example-string",
    "backgroundColor": "example-string",
    "backgroundImage": "example-string",
    "backgroundOpacity": 100,
    "backgroundPosition": "example-string",
    "backgroundRepeat": "example-string",
    "backgroundSize": "example-string",
    "contentAlign": "left",
    "contentWidth": "full",
    "fontColor": "example-string"
  },
  "discounts": [
    {
      "amount": "example-string",
      "frequency": "example-string",
      "id": "example-string",
      "type": "fixed"
    }
  ],
  "displayHeading": true,
  "excludeFromPdf": true,
  "hideSection": true,
  "hideTotalsBottom": true,
  "hideTotalsTop": true,
  "id": "example-string",
  "isScopeOfWork": true,
  "isSignaturesPage": true,
  "kind": "example-string",
  "labels": {
    "outOfPocket": "example-string",
    "tax": "example-string"
  },
  "lineItemsStartExpanded": "none",
  "markupPercentage": "example-string",
  "requireSelection": true,
  "salesTaxPercentage": "example-string",
  "scopeId": "example-string",
  "screenshotUrl": "example-string",
  "selectionType": "single",
  "showCents": true,
  "startNewPdfPage": true,
  "tags": [
    "example-string"
  ],
  "updated_at": "example-string",
  "useRoundedAmounts": true
}

Other

InternalCostConfig1 required

Used by: CreateItem.internal_cost.anyOf[0]·CreateItem.internalCost.anyOf[0]·LineItem.internalCost.anyOf[0]·Modification.internalCost.anyOf[0]·UpdateLineItemApiInput.internal_cost.anyOf[0]·UpdateLineItemApiInput.internalCost.anyOf[0]

Internal (your) cost on a line item or modification. Used by the profit_margins add-on. Never shown to customers. Amount is per unit when the parent has quantity; totals multiply by qty. Frequency follows the parent sell price for profitability rollups. Writable on create/update as `internalCost` or `internal_cost`.

amountnumberrequired

Dollars you pay (per unit when quantity applies).

Example

{
  "amount": 100
}

OutOfPocketConfig1 required

Used by: CreateItem.outOfPocket.anyOf[0]·LineItem.outOfPocket.anyOf[0]·Modification.outOfPocket.anyOf[0]·UpdateLineItemApiInput.outOfPocket.anyOf[0]

Out-of-pocket (pass-through) cost on a line item or modification. Fixed dollars only — no ranges, quantity settings, or discounts. Frequency is independent of the parent sell price. When omitted, inherit from the parent line/mod. Label defaults to "Out-of-Pocket" when omitted.

amountnumberrequired

Fixed dollar amount billed to the client (not marked up, not taxed).

frequencyFrequency

Billing frequency. When omitted, inherit from the parent line/mod.

onceweeklybiweeklymonthlysemi-monthlyquarterlysemi-annuallyannuallyevery-2-yearsevery-3-yearsevery-4-yearsevery-5-yearsevery-6-yearsevery-7-yearsevery-8-yearsevery-9-yearsevery-10-years

labelstring

Display label override (e.g. "Ad Spend"). Default: "Out-of-Pocket".

Example

{
  "amount": 100,
  "frequency": "once",
  "label": "example-string"
}

Pagination

Used by: ListItems (response 200)·ListProposals (response 200)

Pagination metadata for list endpoints

pageinteger

Current page number

limitinteger

Items per page

totalinteger

Total number of items

pagesinteger

Total number of pages

Example

{
  "limit": 20,
  "page": 1,
  "pages": 8,
  "total": 150
}