Billing

Read an invoice

GEThttps://paysuitett.com/api/v1/invoices/{id}

Includes ordered lines, linked tracked hours and entry counts. A draft's number is INV-DRAFT until it is posted, unless one was typed (numberEnteredManually). timeSchedule and workReport are null without time links; all URLs are absolute app links on APP_URL.

Access. Master key, or a personal key held by an owner/admin or accountant. The business must have the invoices service. Runs as the holder under their row-level security.

Path parameters

idstring · uuid: Invoice ID.

Response

200 with a JSON body, as in the example.

curl "https://paysuitett.com/api/v1/invoices/a1b2c3d4-e5f6-4789-90ab-cdef12345678" \
  -H "Authorization: Bearer $PAYSUITETT_API_KEY"

Success

{
  "invoice": {
    "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
    "number": "INV-DRAFT",
    "numberEnteredManually": false,
    "status": "draft",
    "currency": "TTD",
    "exchangeRate": null,
    "customer": {
      "id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
      "name": "Customer",
      "email": "customer@example.com"
    },
    "issueDate": "2026-10-15",
    "dueDate": "2026-11-14",
    "servicePeriod": {
      "start": "2026-10-01",
      "end": "2026-10-14",
      "text": "1–14 Oct 2026"
    },
    "qtyLabel": "hours",
    "notes": null,
    "subtotal": 300,
    "vatTotal": 37.5,
    "total": 337.5,
    "books": {
      "currency": "TTD",
      "subtotal": 300,
      "vatTotal": 37.5,
      "total": 337.5,
      "conversionFeePercent": null,
      "conversionFeeTtd": null,
      "totalTyped": false
    },
    "paid": 0,
    "balanceDue": 0,
    "lines": [
      {
        "position": 0,
        "section": null,
        "description": "Development: Updated checkout",
        "qty": 2,
        "unitPrice": 150,
        "taxTreatment": "standard",
        "vatRate": 0.125,
        "net": 300,
        "vat": 37.5,
        "gross": 337.5,
        "timeSourceKey": "p:a1b2c3d4-e5f6-4789-90ab-cdef12345678",
        "trackedHours": 2,
        "timeEntryCount": 1
      }
    ],
    "urls": {
      "app": "https://paysuitett.com/admin/sales/invoices/6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
      "pdf": "https://paysuitett.com/admin/sales/invoices/6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d/pdf",
      "timeSchedule": "https://paysuitett.com/admin/sales/invoices/6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d/time-schedule",
      "workReport": "https://paysuitett.com/admin/sales/invoices/6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d/work-report"
    }
  }
}