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

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

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

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": [
    {
      "quote_id": 9,
      "terms_id": 2,
      "admin_id": null,
      "external_key": "a0K3D000001Wv8cUAg",
      "currency_id": 1,
      "token": "i5d57esw422k",
      "refnumber": "9",
      "paycycle": "mon",
      "bill_addr1": null,
      "bill_addr2": null,
      "bill_addr3": null,
      "bill_city": null,
      "bill_state": null,
      "bill_postcode": null,
      "bill_country": null,
      "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": "2020-05-04 17:13:35",
      "quote_status_name": "New",
      "quote_status_str": "open-new",
      "quote_status_state": "o",
      "currency_symbol": "$",
      "currency_iso4217": "USD",
      "total": 100.83,
      "setup": 0,
      "terms_name": "Net 30",
      "date": "2020-05-04",
      "due_date": "2020-06-03",
      "paycycle_name": "Monthly",
      "bill_block": "",
      "ship_block": "",
      "url_permalink": "http://dev1.chargeover.test/r/quote/view/i5d57esw422k",
      "url_pdflink": "http://dev1.chargeover.test/r/quote/pdf/i5d57esw422k",
      "url_self": "http://dev1.chargeover.test/admin/r/quote/view/9",
      "url_acceptlink": "http://dev1.chargeover.test/r/quote/accept/i5d57esw422k",
      "url_rejectlink": "http://dev1.chargeover.test/r/quote/reject/i5d57esw422k",
      "customer_id": 35
    }
  ]
}

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...