Foundations
Core company context and reference data that many other resources point at.
Relationship diagram
flowchart TB
Company[Company]
Contact[Contact]
User[User]
Category[Category]
Contact --> Company
User --> Company
Category --> Company
Company is the root context for the authenticated account. Contact and User belong to the company but do not carry a company URI on their attributes - the relationship is implicit via the API token. Categories are company-scoped chart-of-accounts entries.
Currencies appear as ISO code strings (for example GBP, EUR) on projects, invoices, and bank accounts - not as URI references.
Resource catalogue
| Resource | Official docs | SDK |
|---|---|---|
| Company | Company | Implemented |
| Contacts | Contacts | Implemented |
| Users | Users | Implemented |
| Categories | Categories | Implemented |
| Currencies | Currencies | Enum support (CurrencyCode; no REST resource) |
| Email addresses | Email addresses | Implemented |
Documented URI links from other clusters
Resources elsewhere that point into this cluster:
| From | Field | To | Required? |
|---|---|---|---|
| Project | contact |
Contact | Yes (create) |
| Invoice | contact |
Contact | Yes (create) |
| Estimate | contact |
Contact | Yes (create) |
| Bill | contact |
Contact | Yes (create) |
| Credit note | contact |
Contact | Yes (create) |
| Recurring invoice | contact |
Contact | Yes (create) |
| Expense | user |
User | Yes (create) |
| Timeslip | user |
User | Yes (create) |
| Invoice item | category |
Category | Optional |
| Estimate item | category |
Category | Optional |
| Bill item | category |
Category | Optional |
| Bank transaction explanation | category |
Category | Optional |
| Bank transaction explanation | paid_user |
User | Yes (money paid to/from user) |
| Bank transaction explanation | direct_contact |
Contact | Optional (opening balance categories) |
| Journal entry | category |
Category | Yes |
| Journal entry | user |
User | Conditional (user categories) |
| Journal entry | contact |
Contact | Optional (opening balance trade debtors/creditors) |
| Stock item | cost_of_sale_category |
Category | Read-only attribute |
Access levels
From the introduction: contacts need at least Time (extended fields at Contacts & Projects); users need Tax, Accounting & Users for full CRUD; categories are typically read alongside accounting operations.