Skip to main content

Query for quotes

GET 
/api/v3/quote

Available query parameter values for filtering:

  • quote_id
  • customer_id
  • brand_id
  • currency_id
  • refnumber
  • token
  • external_key
  • date
  • bill_state
  • ship_state
  • bill_country
  • ship_country
  • quote_status_str
  • quote_status_state

Valid values for quote_status_str:

  • open-new
  • open-sent
  • closed-won
  • closed-lost

Valid values for quote_status_state:

  • o (any “open” quote, i.e. any that have not been accepted or lost)
  • c (any “closed” quote, i.e. any that have been accepted or lost)

By default, only the overview quote details are returned (i.e. no individual line items). If you get a specific quote by quote id value (e.g. GET /api/v3/quote/1234) you'll get back the invoice line items

Request​

Query Parameters

    where string

    quote_status_state:EQUALS:o

    order string

    quote_id:ASC

    limit string

    2

    offset string

    8

Responses​

Object was fetched successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object[]

  • Array [

    • quote_id integer

    Quote ID #

    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 #

    write_datetime string

    Date/time the quote was created

    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 #

    currency_symbol string

    Currency symbol

    currency_iso4217 string

    Currency ISO 4217 representation

    terms_id integer

    Terms ID number

    class_id integer

    Class ID number for Quickbooks

    terms_name string

    Terms name

    terms_days integer

    Terms Number of days

    brand_id integer

    Brand ID number

    paycycle_name string

    Payment cycle name

    admin_id integer

    Admin/Worker ID number

    admin_name string

    Admin/Worker Name

    token string

    Unique token

    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)

    bill_block string

    Printable billing address

    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)

    ship_block string

    Printable shipping address

    url_permalink string

    URL to view the quote

    url_pdflink string

    URL to get a PDF of the quote

    url_self string

    URL for viewing the quote in the GUI

    url_acceptlink string

    URL to visit to accept the quote

    url_paylink string

    URL to visit to provide a payment method for the quote

    url_rejectlink string

    URL to visit to reject the quote

    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

    won_datetime string

    The Date/time that the quote was accepted

    lost_datetime string

    The Date/time that the quote was rejected

    due_date date

    Date the quote is due

    setup float

    Optional one time free charged for set up expenses

    total float

    Amount due after taxes and fees

    upfront float

    The amount due when you accept the quote 

    subtotal float

    Amount due before taxes and fees

    taxes float

    Amount due for taxes

    quote_status_name string

    Human-friendly quote status

    quote_status_str string

    Status string

    quote_status_state string

    Status code

    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

    object[]

    A list of line items for the quote

  • Array [

    • line_item_id integer

    Invoice line ID #

    quote_id integer

    Invoice ID #

    item_id integer

    Item ID # for this line

    item_name string

    Item name

    item_accounting_sku string

    Item accounting SKU

    item_external_key string

    Item external key

    item_token string

    Item token

    item_type string

    Item type

    quote_line_bundle_id integer

    Quote line bundle ID #

    tierset_id integer

    Tierset ID # for this line

    descrip string

    Description

    line_rate float

    (Deprecated - see the "tierset" attribute)

    line_quantity float

    Quantity

    line_subtotal float

    Line subtotal

    line_total float

    Line total

    expire_recurs integer

    Number of invoices to occur on before expiring

    tax_taxable float

    The total amount that was taxable

    tax_taxed float

    The amount that tax was calculated from

    tax_total float

    The tax amount for this line

    tax_id string
    tax_group_id string
    is_setup bool

    (Deprecated)

    is_base bool

    (Deprecated)

    is_taxed bool
    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

    subscribe_prorate_from_datetime string
    subscribe_prorate_to_datetime string
    tierset array

    Pricing information

  • ]

  • ]

Loading...