API reference

v1 · Public

Quotes

Create an approved quotation at the key's location. The default PDF uses the same layout as POS → Quotations → Print (number like BT-QT/26/00044, line columns, tax, payment instructions from your print template). Customer details are stored as an API placeholder until you assign a directory customer in the hub before converting to a sale.

POST/quotes

Request body

json
{
  "format": "pdf",
  "includeDatasheets": false,
  "expiresAt": "2026-06-30T00:00:00.000Z",
  "note": "Optional note",
  "customer": {
    "name": "Acme Corp",
    "email": "billing@acme.com",
    "phone": "+960 123 4567"
  },
  "lines": [
    {
      "productId": "01H...",
      "unitId": "01H...",
      "quantity": 2,
      "note": "Colour: Z-971 — Soft Grey"
    }
  ]
}

Each line may include an optional note string. For tint colours, send Colour: {code}{name} (for example Colour: Z-971 — Soft Grey). The note appears on the quotation PDF and in the hub like other line notes. The legacy field lineNote is still accepted as an alias for note.

Response formats

  • format: "pdf" returns application/pdf with headers X-Quotation-Id and X-Quotation-Number
  • format: "json" returns quotation summary JSON (no PDF body), including lines[].note when set
bash
curl -s -X POST https://equitypos.com/api/v1/public/quotes \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"pdf","customer":{"name":"Test"},"lines":[{"productId":"...","unitId":"...","quantity":1}]}' \
  --output quote.pdf