Create Quote

POST

/quotes

• Production
• QA

Create a new quote in draft status. Always creates — never sends.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Create a new quote (always starts in draft status).

Mirrors CreateQuoteDTO. At least one of signer_contact_id or signer_email is required. line_items must be non-empty — zero-line quotes can’t be invoiced.

object

accepted_payment_methods

Any of:

Array<string>

Array<string>

Allowed values: ach credit_card wire

null

null

billing_address

Any of:

string

string

<= 2000 characters

null

null

billing_contact_id

Any of:

integer

integer

null

null

billing_email

Any of:

string

string

<= 255 characters

null

null

billing_legal_name

Any of:

string

string

<= 255 characters

null

null

billing_primary_email

Any of:

string

string

<= 255 characters

null

null

contract_duration_unit

Any of:

string

string

Allowed values: months weeks days

null

null

contract_duration_value

Any of:

number

number

>= 0.1 <= 3650

null

null

contract_end_date

Any of:

string

string

null

null

contract_months

Any of:

number

number

>= 0.1 <= 120

null

null

contract_start_date

Any of:

string

string

null

null

currency

string

default: USD >= 3 characters <= 3 characters

deal_id

Any of:

string

string

null

null

line_items

required

Array<object>

>= 1 items

One line item on a quote request body.

Shape mirrors integrations_v4.interfaces.fastapi.quote_router.LineItemDTO exactly. Pass either stripe_product_id + stripe_price_id (for a Stripe-catalogue product) or manual_product_id (for an org-owned manual catalogue entry), or neither (for a custom one-off line). Authorization is enforced server-side — non-quotable products are rejected with 400.

object

billing_frequency

Any of:

string

string

Allowed values: one_time month year quarter

null

null

billing_start_date

Any of:

string

string format: date

null

null

description

Any of:

string

string

<= 2000 characters

null

null

discount_pct

number

<= 100

manual_product_id

Any of:

string

string

null

null

product_name

required

string

>= 1 characters <= 255 characters

quantity

integer

default: 1 >= 1 <= 10000

sort_order

integer

start_month

Contract month when recurring billing begins; 1 means at contract start. Use billing_start_date instead for an exact date.

integer

default: 1 >= 1 <= 120

stripe_price_id

Any of:

string

string

null

null

stripe_product_id

Any of:

string

string

null

null

unit_amount

required

In cents

integer

<= 1000000000

marketing_rights

Any of:

Array<string>

Array<string>

Allowed values: logo quote case_study

null

null

mashup_company_id

Any of:

integer

integer

null

null

notes

Any of:

string

string

<= 10000 characters

null

null

owner_id

Any of:

string

string

<= 255 characters

null

null

payment_terms

string

default: net_30

Allowed values: due_on_receipt net_15 net_30 net_45 net_60 net_90

privacy_content

Any of:

string

string

<= 50000 characters

null

null

public_notes

Any of:

string

string

<= 50000 characters

null

null

signer_contact_id

Any of:

integer

integer

null

null

signer_email

Any of:

string

string

<= 255 characters

null

null

signer_name

Any of:

string

string

<= 255 characters

null

null

tax_amount

integer

<= 1000000000

template_id

Any of:

string

string

null

null

terms_content

Any of:

string

string

<= 50000 characters

null

null

title

required

string

>= 1 characters <= 500 characters

valid_until

Any of:

string

string

null

null

Responses

201

Successful Response

object

data

required

Full row + line items + activity + envelope from GET /quotes/{id}.

Open dict because _get_quote_detail returns the dynamic _row_to_dict shape plus resolved contact/company/envelope blocks.

object

activity

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

envelope

Any of:

object

object

key

additional properties

any

null

null

id

Any of:

string

string

null

null

line_items

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

quote_number

Any of:

string

string

null

null

status

Any of:

string

string

null

null

title

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string