Aerion API

Resource: Absence — CRUD endpoints

Resource: AbsenceRequest — CRUD endpoints

Resource: AbsenceType — CRUD endpoints

Account — domain-specific endpoints

Analytics — domain-specific endpoints

Approval — domain-specific endpoints

Resource: Client — CRUD endpoints

Resource: ClientExternalIntegration — CRUD endpoints

Resource: Color — CRUD endpoints

Resource: Contact — CRUD endpoints

Resource: Document — CRUD endpoints

Resource: Expense — CRUD endpoints

Resource: ExpenseCategory — CRUD endpoints

File — domain-specific endpoints

Resource: Holiday — CRUD endpoints Deprecated. Public holidays are now managed via the PublicHoliday absence type. This read-only lookup is retained for backwards compatibility.

Resource: IntegrationService — CRUD endpoints

Resource: IntegrationServiceType — CRUD endpoints

Resource: Invoice — CRUD and model-specific endpoints

Resource: InvoiceExternalIntegration — CRUD endpoints

Resource: OvertimeReduction — CRUD and model-specific endpoints

Resource: PlannedInvoice — CRUD and model-specific endpoints

Planner — domain-specific endpoints

Resource: PlannerAssignment — CRUD endpoints

Resource: Project — CRUD and model-specific endpoints

Resource: ProjectDay — CRUD endpoints Per-(project, day) approval state. An APPROVED ProjectDay closes that (project, day) to further time-entry creation by any user, and implies every existing WORK entry on that day is also APPROVED. Read-only via this resource — to approve or unapprove a project day, use the approval controller endpoints (POST /v1/approval/bulk-approve). Direct create / update / destroy on /v1/project-days is not supported.

Resource: ProjectMilestone — CRUD endpoints

Resource: Reference — CRUD endpoints

Resource: ReferenceFamily — CRUD endpoints

Resource: ReferenceFamilyAssignment — CRUD endpoints

Resource: Role — CRUD endpoints

Resource: SkillAssignment — CRUD endpoints Assigns a skill to a user, recording their proficiency. A user can hold each skill at most once. When a skill is removed from a user the assignment is archived (status set to 0) rather than deleted, so the history is preserved.

Resource: SkillSet — CRUD endpoints A named collection of skills. Skills (Tag records with a type) are added to a skill set via TagAssignment. Each skill set belongs to a SkillSetCategory. Skill sets are a convenience for bulk-applying skills to users — they are not permanently linked to users. Adding or removing a skill from a skill set does not change the skills already assigned to any user.

Resource: SkillSetCategory — CRUD endpoints Groups skill sets.

Resource: Tag — CRUD endpoints A label attached to other records. This model does double duty. When type is null the row is a plain tag — a free-form label attached to clients, projects, tasks, users, and expense categories via TagAssignment. When type is set the row is a skill (part of Skill Management): 1 = skill, 2 = language, 3 = certificate. Skills require a category and are assigned to users via SkillAssignment. Which rows a GET returns depends on the type filter and the includeSkills query parameter.

Resource: TagAssignment — CRUD endpoints Attaches a Tag to another record, identified by (model, record). Used to tag entities such as clients, projects, tasks, users, and expense categories. To relate a skill (a skill-type Tag) to a user, use SkillAssignment instead — not this model.

Resource: TagCategory — CRUD endpoints Categorizes skills. Although the Tag model does double duty as both plain tags and skills, this object is currently used only to categorize skills (a skill must belong to a category). Categorizing plain tags is intended as a future feature.

Resource: Task — CRUD endpoints

Resource: TaskAssignment — CRUD endpoints

Resource: Team — CRUD endpoints

Resource: TeamAssignment — CRUD endpoints

Resource: TimeEntry — CRUD and model-specific endpoints The model serves three purposes distinguished by trackingType. The three are independent in reporting: WORK totals are not affected by WORKTIME or BREAK. Required fields depend on both trackingType and the account-level AccountSetting.timerMode:

• WORK (project time) — project and task are required. Follows timerMode: in DURATION, provide duration + sorting (no times); in START_TIME_END_TIME, provide startTime + endTime and omit sorting (omit endTime while running).
• WORKTIME (clock in/out) — project and task must be omitted. Always uses startTime + endTime, regardless of timerMode.
• BREAK — project and task must be omitted. Follows timerMode only when the account does not use worktime. When worktime is enabled, BREAK always uses startTime + endTime (like WORKTIME), but may still include sorting.

Net worktime over a period is sum(WORKTIME.duration) − sum(BREAK.duration).

Resource: User — CRUD and model-specific endpoints

Resource: UserAssignment — CRUD endpoints

Resource: UserEmployment — CRUD endpoints

Resource: UserIntegration — CRUD endpoints

Resource: VacationBudget — CRUD and model-specific endpoints