Get a specific quote

GET 
/api/v3/quote/:quote_id

If the quote has been turned into an invoice, there will be an invoices attribute which links to the related invoice.

If the quote has been turned into a subscription, there will be a packages attribute which links to the related subscription.

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

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

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "quote_id": 0,
    "refnumber": "string",
    "external_key": "string",
    "paycycle": "string",
    "nickname": "string",
    "customer_id": 0,
    "write_datetime": "string",
    "date": "2024-07-29",
    "validuntil_date": "2024-07-29",
    "holduntil_datetime_str": "string",
    "currency_id": 0,
    "currency_symbol": "string",
    "currency_iso4217": "string",
    "terms_id": 0,
    "class_id": 0,
    "terms_name": "string",
    "terms_days": 0,
    "brand_id": 0,
    "paycycle_name": "string",
    "admin_id": 0,
    "admin_name": "string",
    "token": "string",
    "bill_addr1": "string",
    "bill_addr2": "string",
    "bill_addr3": "string",
    "bill_city": "string",
    "bill_state": "string",
    "bill_postcode": "string",
    "bill_country": "string",
    "bill_notes": "string",
    "bill_block": "string",
    "ship_addr1": "string",
    "ship_addr2": "string",
    "ship_addr3": "string",
    "ship_city": "string",
    "ship_state": "string",
    "ship_postcode": "string",
    "ship_country": "string",
    "ship_notes": "string",
    "ship_block": "string",
    "url_permalink": "string",
    "url_pdflink": "string",
    "url_self": "string",
    "url_acceptlink": "string",
    "url_paylink": "string",
    "url_rejectlink": "string",
    "url_acceptredirect": "string",
    "url_rejectredirect": "string",
    "won_datetime": "string",
    "lost_datetime": "string",
    "due_date": "2024-07-29",
    "setup": 0,
    "total": 0,
    "upfront": 0,
    "subtotal": 0,
    "taxes": 0,
    "quote_status_name": "string",
    "quote_status_str": "string",
    "quote_status_state": "string",
    "memo": "string",
    "custom_1": "string",
    "custom_2": "string",
    "custom_3": "string",
    "custom_4": "string",
    "custom_5": "string",
    "custom_6": "string",
    "custom_7": "string",
    "custom_8": "string",
    "custom_9": "string",
    "custom_10": "string",
    "custom_11": "string",
    "custom_12": "string",
    "custom_13": "string",
    "custom_14": "string",
    "custom_15": "string",
    "custom_16": "string",
    "custom_17": "string",
    "custom_18": "string",
    "custom_19": "string",
    "custom_20": "string",
    "line_items": [
      {
        "line_item_id": 0,
        "quote_id": 0,
        "item_id": 0,
        "item_name": "string",
        "item_accounting_sku": "string",
        "item_external_key": "string",
        "item_token": "string",
        "item_type": "string",
        "quote_line_bundle_id": 0,
        "tierset_id": 0,
        "descrip": "string",
        "line_rate": 0,
        "line_quantity": 0,
        "line_subtotal": 0,
        "line_total": 0,
        "expire_recurs": 0,
        "tax_taxable": 0,
        "tax_taxed": 0,
        "tax_total": 0,
        "tax_id": "string",
        "tax_group_id": "string",
        "custom_1": "string",
        "custom_2": "string",
        "custom_3": "string",
        "custom_4": "string",
        "custom_5": "string",
        "custom_6": "string",
        "custom_7": "string",
        "custom_8": "string",
        "custom_9": "string",
        "custom_10": "string",
        "custom_11": "string",
        "custom_12": "string",
        "custom_13": "string",
        "custom_14": "string",
        "custom_15": "string",
        "custom_16": "string",
        "custom_17": "string",
        "custom_18": "string",
        "custom_19": "string",
        "custom_20": "string",
        "subscribe_prorate_from_datetime": "string",
        "subscribe_prorate_to_datetime": "string",
        "tierset": [
          null
        ]
      }
    ]
  }
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "quote_id": 198,
    "terms_id": 2,
    "admin_id": 1,
    "currency_id": 1,
    "token": "659m6ys792j0",
    "refnumber": "198",
    "paycycle": "mon",
    "bill_addr1": "72 E Blue Grass Road",
    "bill_addr2": null,
    "bill_addr3": null,
    "bill_city": "Minneapolis",
    "bill_state": "MN",
    "bill_postcode": "55416",
    "bill_country": "United States",
    "bill_notes": null,
    "ship_addr1": null,
    "ship_addr2": null,
    "ship_addr3": null,
    "ship_city": null,
    "ship_state": null,
    "ship_postcode": null,
    "ship_country": null,
    "ship_notes": null,
    "memo": null,
    "custom_1": null,
    "custom_2": null,
    "custom_3": null,
    "write_datetime": "2019-08-14 10:38:50",
    "quote_status_name": "Accepted",
    "quote_status_str": "closed-won",
    "quote_status_state": "c",
    "currency_symbol": "$",
    "currency_iso4217": "USD",
    "total": 10.4,
    "setup": 100,
    "terms_name": "Net 30",
    "date": "2019-08-14",
    "due_date": "2019-09-13",
    "bill_block": "72 E Blue Grass Road\r\nMinneapolis, MN 55416\r\nUnited States",
    "ship_block": "",
    "url_permalink": "http://dev1.chargeover.test/r/quote/view/659m6ys792j0",
    "url_pdflink": "http://dev1.chargeover.test/r/quote/pdf/659m6ys792j0",
    "url_self": "http://dev1.chargeover.test/admin/r/quote/view/198",
    "url_acceptlink": "http://dev1.chargeover.test/r/quote/accept/659m6ys792j0",
    "url_rejectlink": "http://dev1.chargeover.test/r/quote/reject/659m6ys792j0",
    "customer_id": 294,
    "line_items": [
      {
        "quote_id": 198,
        "item_id": 1,
        "tierset_id": 175,
        "descrip": "This is a ChargeOver test item.",
        "line_rate": 10.95,
        "line_quantity": 1,
        "is_base": false,
        "custom_1": null,
        "custom_2": null,
        "custom_3": null,
        "item_name": "My Test Service Plan",
        "item_external_key": null,
        "item_token": "d70a9a880d95",
        "item_accounting_sku": null,
        "line_total": 10.95,
        "line_subtotal": 10.95,
        "line_item_id": 367,
        "tierset": {
          "tierset_id": 175,
          "currency_id": 1,
          "setup": 100,
          "base": 10.95,
          "minimum": 0,
          "percent": 0,
          "paycycle": "evy",
          "pricemodel": "fla",
          "write_datetime": "2019-08-14 10:38:45",
          "mod_datetime": "2019-08-14 10:38:45",
          "currency_symbol": "$",
          "currency_iso4217": "USD",
          "setup_formatted": "$ 100.00",
          "base_formatted": "$ 10.95",
          "minimum_formatted": "$ 0.00",
          "percent_formatted": "0 %",
          "pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
          "tiers": []
        }
      },
      {
        "quote_id": 198,
        "item_id": 2,
        "tierset_id": 174,
        "descrip": "Discount",
        "line_rate": 0,
        "line_quantity": 1,
        "is_base": false,
        "custom_1": null,
        "custom_2": null,
        "custom_3": null,
        "item_name": "Discount",
        "item_external_key": null,
        "item_token": "62ucb1dhemv3",
        "item_accounting_sku": null,
        "line_total": 0,
        "line_subtotal": 0,
        "line_item_id": 368,
        "tierset": {
          "tierset_id": 174,
          "currency_id": 1,
          "setup": 0,
          "base": 0,
          "minimum": 0,
          "percent": 5,
          "paycycle": "evy",
          "pricemodel": "fla",
          "write_datetime": "2019-08-14 10:38:40",
          "mod_datetime": "2019-08-14 10:38:40",
          "currency_symbol": "$",
          "currency_iso4217": "USD",
          "setup_formatted": "$ 0.00",
          "base_formatted": "$ 0.00",
          "minimum_formatted": "$ 0.00",
          "percent_formatted": "5 %",
          "pricemodel_desc": "Flat Pricing (example: $X dollars every billing cycle)",
          "tiers": []
        }
      }
    ],
    "sent": [],
    "invoices": [],
    "packages": [
      {
        "package_id": 44
      }
    ]
  }
}

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
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

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

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...