REST API Contracts

📜 REST API: Contracts

The complete usage guide for the Contracts module of the REST API — contracts, term tabs, suppliers and their contacts. Mirrors the interactive documentation at System → API → Documentation (with its live "Try it" tester).

Note

New to the API? The basics table on REST API: Tickets covers base URL, authentication, the response envelope, error codes, rate limits and PATCH semantics — identical across all modules.

What's distinctive about Contracts:

⏳ Renewal filters built in	expiring_within_days, notice_within_days and expired are the module's own dashboard/Watchtower SQL shapes exposed as parameters — renewal reports are one call.
🔢 Contract numbers can't collide via the API	The UI has no uniqueness check on contract_number; the API refuses duplicates with a 409 pointing at the existing contract.
🏭 Suppliers get their full record	The lite picker list stays at GET /suppliers (under reference.read); the full CRUD — registration/VAT, address, questionnaire dates, contacts — lives under the new suppliers permission. The API can also set supplies_assets (the flag the Assets module filters suppliers by), which the UI never writes.
📄 Documents are links, not uploads	The module stores external DMS URLs (dms_link, dpia_dms_link) — plain string fields, no file upload exists or is needed.
🚪 The RFP Builder is not exposed	It's internal-only by design (suppliers never log in) and stays UI-only.

---

🚀 Quick start

Register a supplier and its contract, with renewal tracking from day one:

B="https://your-server/api/v1"; K="Authorization: Bearer fitsm_…"

# 1. Supplier (flagged as an asset supplier so it appears in Assets pickers)
SUP=$(curl -s -X POST "$B/suppliers" -H "$K" -H "Content-Type: application/json" -d '{
  "legal_name": "Acme Print Ltd", "trading_name": "Acme Print", "supplies_assets": true
}' | jq -r '.data.id')

# 2. Contract with value, end date and notice date
curl -s -X POST "$B/contracts" -H "$K" -H "Content-Type: application/json" -d "{
  \"contract_number\": \"CN-2026-014\", \"title\": \"Managed print services\",
  \"supplier_id\": $SUP,
  \"contract_start\": \"2026-08-01\", \"contract_end\": \"2028-07-31\",
  \"notice_period_days\": 90, \"notice_date\": \"2028-05-02\",
  \"contract_value\": 24000, \"currency\": \"GBP\"
}"

---

📜 Contracts

🟢 GET /contracts — list / search   🔑 contracts.read

Parameter	Description
q	Search contract number, title and supplier legal name
supplier_id · contract_status_id · contract_owner_id · payment_schedule_id	Id filters
is_active	true / false
expiring_within_days	⏳ Active contracts whose contract_end falls within N days (Watchtower's 30/90-day windows as a parameter)
notice_within_days	🔔 Active contracts whose notice_date falls within N days — the "act now or auto-renew" report
expired	true = contract_end already passed
ends_before / ends_after	YYYY-MM-DD bounds
sort	contract_end (default), contract_start, created_at, title, contract_number, contract_value, id — prefix - for descending
page / per_page	Pagination — default 1 / 25, max 100

The contract shape:

{ "id": 4, "contract_number": "CN-2026-014", "title": "Managed print services",
  "description": null,
  "supplier": { "id": 5, "name": "Acme Print" },
  "owner": { "id": 1, "name": "Administrator" },
  "status": { "id": 2, "name": "Active" },
  "payment_schedule": { "id": 1, "name": "Annual" },
  "dates": { "start": "2026-08-01", "end": "2028-07-31",
             "notice_date": "2028-05-02", "notice_period_days": 90 },
  "value": { "amount": 24000.0, "currency": "GBP" },
  "cost_centre": null, "dms_link": null,
  "governance": { "terms_status": null, "personal_data_transferred": false,
                  "dpia_required": false, "dpia_completed_date": null, "dpia_dms_link": null },
  "is_active": true, "created_at": "2026-07-03T15:40:52Z" }

🔵 POST /contracts — create   🔑 contracts.create

contract_number + title required; everything else optional. Lookup ids validated (422 naming the field), dates YYYY-MM-DD, currency a 3-letter code (lower-case is normalised). Duplicate contract_number → 409 with the existing contract's id — a deliberate API-only safeguard. Returns 201.

🟢 GET /contracts/{id}   🔑 contracts.read · 🟠 PATCH /contracts/{id}   🔑 contracts.update

Everything creatable is patchable; null clears; renaming to a contract_number in use → 409. Set is_active: false to retire a contract without deleting it — usually the right move.

🔴 DELETE /contracts/{id}   🔑 contracts.delete

Warning

Permanent. The contract and its term-tab contents are removed; tasks, calendar events and RFPs that referenced it are unlinked (kept, not deleted). Prefer is_active: false for retirement.

---

📑 Contract terms

Term tabs (Termination, Liability, …) are configured in Contracts → Settings; each contract stores its own content per tab.

🟢 GET /contracts/{id}/terms   🔑 contract_terms.read

Every active tab with this contract's content (null where nothing recorded).

🔵 POST /contracts/{id}/terms   🔑 contract_terms.update

{ "terms": [ { "term_tab_id": 1, "content": "Termination requires 90 days written notice." } ] }

Per-tab upsert, exactly like the UI — only the tabs you send are touched. Returns the full term set.

---

🏭 Suppliers

🟢 GET /suppliers/{id}   🔑 suppliers.read

The full record — registration/VAT numbers, address, questionnaire dates, type/status, supplies_assets, contract + contact counts, and the contact list inline.

🔵 POST /suppliers   🔑 suppliers.create · 🟠 PATCH /suppliers/{id}   🔑 suppliers.update

Only legal_name is required. All identity/address/questionnaire fields accepted, plus supplies_assets — set it true for hardware vendors so they appear in the Assets module's supplier pickers (the UI can't set this flag; it's normally only flipped by the asset-import migration).

🔴 DELETE /suppliers/{id}   🔑 suppliers.delete

Deletes the supplier; its contracts, contacts and assets keep their rows but are unlinked (supplier set to none) — the same behaviour as the UI.

---

👤 Supplier contacts

Endpoint	Permission	Notes
🟢 GET /suppliers/{id}/contacts	🔑 supplier_contacts.read	The supplier's people
🔵 POST /suppliers/{id}/contacts	🔑 supplier_contacts.create	first_name + surname required; email/mobile/job title/dial numbers optional
🟠 PATCH /suppliers/{id}/contacts/{contact_id}	🔑 supplier_contacts.update	Send only what changes
🔴 DELETE /suppliers/{id}/contacts/{contact_id}	🔑 supplier_contacts.delete	Removes the contact

---

📚 Reference data

Under the shared 🔑 reference.read permission (all populated via Contracts → Settings — empty on a fresh install):

Endpoint	Returns
🟢 GET /contract-statuses	Contract statuses
🟢 GET /payment-schedules	Payment schedules
🟢 GET /supplier-types · GET /supplier-statuses	Supplier lookups
🟢 GET /contract-term-tabs	The configured term tabs
🟢 GET /suppliers	The lite supplier picker list (id, name, supplies_assets)

---

🧪 Worked example: renewal radar

A read-only key (contracts: read) feeds a monthly procurement report:

B="https://your-server/api/v1"; K="Authorization: Bearer fitsm_…"

# Contracts needing a renewal decision in the next 90 days, soonest first
curl -s -H "$K" "$B/contracts?expiring_within_days=90&sort=contract_end&per_page=100" \
  | jq -r '.data[] | [.contract_number, .dates.end, (.supplier.name // "-"),
                      ((.value.amount // 0) | tostring) + " " + (.value.currency // ""), .title] | @tsv'

# The urgent list: notice deadlines in the next 30 days (miss these and it auto-renews)
curl -s -H "$K" "$B/contracts?notice_within_days=30&sort=contract_end" \
  | jq -r '.data[] | "⚠️  \(.dates.notice_date)  \(.contract_number)  \(.title)"'

And the ERP direction — syncing supplier master data in:

SUP=$(curl -s -H "$K" "$B/suppliers?" ) # lite list via GET /suppliers (reference.read)
curl -s -X PATCH "$B/suppliers/5" -H "$K" -H "Content-Type: application/json" \
  -d '{"vat_number": "GB123456789", "supplier_status_id": 2}'

---

Under the hood: REST API — How It Works · Other modules: Tickets · Assets · Problems · Changes · Knowledge · Tasks · CMDB · Keys & permissions: System → API (System module) · Module docs: Contracts.