latestOpenAPI 3.0.0Apache 2.02026-08-06199181.1 MB

e0d144609998

Quotes

List Quotes

Retrieve a list of all quotes

get/quotes

Query parameters

account_idinteger

Search Quotes by account Id

account_namestring

Search Quotes by account name

account_numberinteger

Search Quotes by account number

quote_datestring

Search Quotes by invoice date

quote_numberstring

Search Quotes by invoice number

organization_idstring

Search Invoices by organization id

statusstring

Search Quotes by status

{"stackTrail":"paths:/quotes:get:parameters:7:schema","oasType":"schema","type":"unknown"}

Search Quotes by sub-total

{"stackTrail":"paths:/quotes:get:parameters:8:schema","oasType":"schema","type":"unknown"}

Search Quotes by total

{"stackTrail":"paths:/quotes:get:parameters:9:schema","oasType":"schema","type":"unknown"}

Search Quotes by total discount

{"stackTrail":"paths:/quotes:get:parameters:10:schema","oasType":"schema","type":"unknown"}

Search Quotes by total tax

voucher_header_idinteger

Search Quotes by voucher header id

filtersobject

Filter Quotes by the above query parameters. <br /> <b>Example:</b> { "total[gt]" : 6000 } which will search for Quotes that have a total greater than "6000".

sort[asc]'quote_date' | 'quote_number' | 'total'

Sort Quotes in ascending order

sort[desc]'quote_date' | 'quote_number' | 'total'

Sort quotes in descending order

pageinteger

The particular page to return

per_pageinteger

The number of items to return per page Default: 50 Limit: 200

Response

Successful operation

messagestring

Example response

{
  "message": "success.",
  "quotes": [
    {
      "id": 4,
      "voucher_header_id": 9,
      "account": {
        "id": 25,
        "organization_id": "0001",
        "name": "client 1",
        "account_label": "client 1 (USD)",
        "account_data": "9999",
        "system_account": "no",
        "account_type_id": 15,
        "account_type": "Third Party",
        "number": "2",
        "currency_id": 234,
        "currency": "USD",
        "model_id": 2,
        "member_id": 1,
        "model_name": "Company",
        "model_type": "client",
        "rate_per_hour": 300,
        "organization": {
          "id": "0001",
          "name": "My Entity",
          "country": "US"
        },
        "client": {
          "id": "00000002",
          "discount_percentage": "0.000",
          "member_label": "COM00000001"
        }
      },
      "organization_id": "0001",
      "quote_number": "0000003",
      "reference_number": "0000003",
      "purchase_order": "2134124",
      "quote_reference": "213",
      "bill_to": "9999",
      "quote_date": "2024-09-17 00:00:00",
      "due_on": "2024-10-18 00:00:00",
      "paid_status": "open",
      "display_discount": 1,
      "quote_reminder": {
        "id": "00000004",
        "user_id": "0000000002",
        "summary": "The Quote 213 is due on 2024-10-18 00:00 \\n Quote id: 213 \\n Client: client 1",
        "reminder_date": "2024-09-17",
        "reminder_time": 1,
        "reminder_time_type": "day",
        "reminder_type": "popup"
      },
      "term_id": 1,
      "terms": "In Advance",
      "total": "1999.990",
      "notes": "Thank you asadasdasdfor your business.",
      "exchange_rate": "1.0000000000000000",
      "description": "sdadfvvssvsfdvc",
      "quote_details": [
        {
          "id": 11,
          "account_id": 14,
          "quantity": "2",
          "description": "Product 1",
          "rate": "2000.000",
          "discount": "0.00",
          "total": "4000.00",
          "quote_id": 4,
          "taxable": true,
          "item_date": "2024-09-17 00:00:00",
          "item_display_date": "2024-09-17",
          "details": "dfvf",
          "type": "product",
          "item_ref_number": "4"
        }
      ]
    }
  ]
}