Skip to main content
GET
/
quotations
List quotations
curl --request GET \
  --url https://api.heffl.com/api/v2/quotations \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "number": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "subject": "<string>",
      "expiryDate": "2023-11-07T05:31:56Z",
      "conversionRate": 123,
      "isInclusiveTax": true,
      "clientId": "<string>",
      "contactId": "<string>",
      "dealId": "<string>",
      "salesPersonId": "<string>",
      "templateId": "<string>",
      "contentHtml": "<string>",
      "internalNotes": "<string>",
      "totalAmount": 123,
      "subtotalAmount": 123,
      "totalTaxAmount": 123,
      "totalDiscountAmount": 123,
      "tagIds": [
        "<string>"
      ],
      "lineItems": [
        {
          "name": "<string>",
          "quantity": 123,
          "price": 123,
          "productId": "<string>",
          "description": "<string>",
          "tax": 123,
          "taxRateId": "<string>",
          "discount": 123,
          "scope": "<string>"
        }
      ],
      "markedAcceptedOn": "2023-11-07T05:31:56Z",
      "markedRejectedOn": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Query Parameters

cursor
string

Cursor for pagination. Pass the previous response meta.nextCursor value to fetch the next page.

pageSize
integer
default:30

Number of items to return per page (max 100)

Required range: 1 <= x <= 100

Search by number, subject, client name, or line item text

orderBy
enum<string>
default:createdAt

Field to sort results by

Available options:
createdAt,
date,
number,
expiryDate
orderDir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
filters
object

Structured filters (status, clientId, salesPersonId, tagId, productId, templateId, dealId, dates). Option values use prefixed string IDs. See the Listing & filters guide.

Response

OK

data
object[]
required
meta
object
required