Create a quote

POST 
/api/v3/quote

Requirements

• You must specify an existing customer_id, customer_token, or customer_external_key value.
• You must specify at least one line item.
• Each line item must refer to an existing item_id value.
• You must specify a paycycle:

• one - a quote for a one-time invoice
• mon - a quote for a monthly subscription
• 2mn - a quote for a subscription that invoices the customer every 2 months
• yrl - a quote for a yearly subscription


• 2yr - a quote for a subscription that invoices the customer every 2 years
• 3yr - a quote for a subscription that invoices the customer every 3 years
• 1wk - a quote for a weekly subscription
• 2wk - a quote for a subscription that invoices the customer every 2 weeks


• qtr - a quote for a quarterly subscription
• six - a quote for a subscription that invoices customers every 6 months

Notes

• The id value in the response is the quote_id value of the newly created quote.
• The "Location:" header will provide a direct API link to the newly created quote.

Request

application/json

Body

refnumber string

Quote reference number

external_key string

External key value

paycycle string

Payment cycle for the quote (e.g. monthly, etc.)

nickname string

Quote nickname

customer_id integer

Customer ID #

date date

Quote date

validuntil_date date

Quote valid until

holduntil_datetime_str string

Date/time invoicing for the resulting subscription to be delayed until

currency_id integer

Currency ID #

terms_id integer

Terms ID #

class_id integer

Class ID # for Quickbooks

brand_id integer

Brand ID #

admin_id integer

Admin/Worker ID #

bill_addr1 string

Billing address line 1

bill_addr2 string

Billing address line 2

bill_addr3 string

Billing address line 3

bill_city string

Billing address city

bill_state string

Billing address state

bill_postcode string

Billing address postal code

bill_country string

Billing address country

bill_notes string

(deprecated)

ship_addr1 string

Shipping address line 1

ship_addr2 string

Shipping address line 2

ship_addr3 string

Shipping address line 3

ship_city string

Shipping address city

ship_state string

Shipping address state

ship_postcode string

Shipping address postal code

ship_country string

Shipping address country

ship_notes string

(deprecated)

url_acceptredirect string

URL the lead should be redirected to after accepting a quote

url_rejectredirect string

URL the lead should be redirected to after rejecting a quote

memo string

Memo/notes to customer

custom_1 string

Custom field #1

custom_2 string

Custom field #2

custom_3 string

Custom field #3

custom_4 string

Custom field #4

custom_5 string

Custom field #5

custom_6 string

Custom field #6

custom_7 string

Custom field #7

custom_8 string

Custom field #8

custom_9 string

Custom field #9

custom_10 string

Custom field #10

custom_11 string

Custom field #11

custom_12 string

Custom field #12

custom_13 string

Custom field #13

custom_14 string

Custom field #14

custom_15 string

Custom field #15

custom_16 string

Custom field #16

custom_17 string

Custom field #17

custom_18 string

Custom field #18

custom_19 string

Custom field #19

custom_20 string

Custom field #20

line_items array

A list of line items for the quote

Responses

201

Object was created successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "id": 0
  }
}

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...