Multi-tenant ERP for Al Maida joinery & fit-out. Every endpoint below is served under one host; authentication is a bearer token obtained from the login endpoint. This page is generated directly from the live OpenAPI document, so it always matches the running API.
All paths are relative to the API host. In local development the UI proxies /api to the backend, so calls stay same-origin.
http://localhost:5101
Post credentials to get an access token (JWT). Send it as a bearer header on every other call. A refresh cookie is set automatically.
POST /api/v1/auth/login
{ "email": "...", "password": "..." }
→ { "accessToken": "eyJ…", "companyId": "…", … }
Attach the token to every request:
Authorization: Bearer <accessToken>
The token carries your company and roles — there is no separate tenant header.
On a 401, call POST /api/v1/auth/refresh (uses the cookie) to get a new token, then retry. POST /api/v1/auth/logout ends the session.
401 not signed in · 403 lacks permission · 404 not found · 409 conflict · 422 a rule refused the write (nothing is saved).
Each card shows the method, path, and what it does. Expand Parameters, body & responses for the exact fields — * marks required ones.
/api/v1/admin/companies
| Name | In | Type | Description |
|---|---|---|---|
| X-Platform-Key | header | string |
| Field | Type | Description |
|---|---|---|
| name | string? |
|
| legalName | string? |
|
| adminEmail | string? |
|
| adminFullName | string? |
|
| adminPassword | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ProvisionResult |
/api/v1/appraisals
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| period | string? |
|
| rating | integer · int32 |
|
| comments | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedAppraisalResponse |
/api/v1/appraisals/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | AppraisalDto |
/api/v1/appraisals/employee/{employeeId}
| Name | In | Type | Description |
|---|---|---|---|
| employeeId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | AppraisalDto[] |
/api/v1/attendance/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | AttendanceDto |
/api/v1/attendance/{id}/clock-out
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/attendance/clock-in
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| siteId | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ClockedIn |
/api/v1/auth/login
| Field | Type | Description |
|---|---|---|
string? |
||
| password | string? |
|
| companyId | string · uuid? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | AuthResponse |
/api/v1/auth/logout
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/auth/refresh
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | AuthResponse |
/api/v1/auth/switch-company
| Field | Type | Description |
|---|---|---|
| companyId | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | AuthResponse |
/api/v1/bids
| Field | Type | Description |
|---|---|---|
| rfqId | string · uuid |
|
| supplierId | string · uuid |
|
| unitPrice | number · double |
|
| leadTimeDays | integer · int32 |
|
| terms | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedBidResponse |
/api/v1/bids/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | BidDto |
/api/v1/bids/award
| Field | Type | Description |
|---|---|---|
| rfqId | string · uuid |
|
| bidId | string · uuid |
|
| justification | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/capas
| Field | Type | Description |
|---|---|---|
| ncrId | string · uuid? |
|
| actionType | string? |
|
| description | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedCapaResponse |
/api/v1/capas/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CapaDto |
/api/v1/capas/{id}/close
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CapaDto |
/api/v1/capas/{id}/verify
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| note | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CapaDto |
/api/v1/cash-advances
| Field | Type | Description |
|---|---|---|
| amount | number · double |
|
| purpose | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedCashAdvanceResponse |
/api/v1/cash-advances/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CashAdvanceDto |
/api/v1/cash-advances/{id}/close
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| receiptImageRef | string? |
|
| inspected | boolean |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/cash-advances/{id}/disburse
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/competencies
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| code | string? |
|
| validFrom | string · date-time |
|
| validTo | string · date-time? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedCompetencyResponse |
/api/v1/competencies/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CompetencyDto |
/api/v1/competencies/employee/{employeeId}
| Name | In | Type | Description |
|---|---|---|---|
| employeeId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CompetencyDto[] |
/api/v1/environment/obligations
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ComplianceObligationDto[] |
/api/v1/environment/obligations
| Field | Type | Description |
|---|---|---|
| title | string? |
|
| authority | string? |
|
| reference | string? |
|
| validFrom | string · date |
|
| expiresOn | string · date |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedObligationResponse |
/api/v1/environment/obligations/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ComplianceObligationDto |
/api/v1/consumption
| Field | Type | Description |
|---|---|---|
| productionOrderId | string · uuid |
|
| quantity | number · double |
|
| isVariance | boolean |
|
| varianceReason | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RecordedConsumptionResponse |
/api/v1/consumption/{productionOrderId}
| Name | In | Type | Description |
|---|---|---|---|
| productionOrderId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ConsumptionSummaryDto |
/api/v1/contracts
| Field | Type | Description |
|---|---|---|
| quotationId | string · uuid |
|
| scope | string? |
|
| boqRef | string? |
|
| paymentTerms | string? |
|
| retentionPct | number · double? |
|
| warrantyMonths | integer · int32? |
|
| ldTerms | string? |
|
| variationClause | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedContractResponse |
/api/v1/contracts/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ContractDto |
/api/v1/contracts/{id}/sign
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| rowVersion | integer · int32 |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SignedContract |
/api/v1/credit-notes
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| amount | number · double |
|
| reason | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreditNoteResult |
/api/v1/credit-notes/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreditNoteDto |
/api/v1/customers
| Name | In | Type | Description |
|---|---|---|---|
| type | query | string |
|
| includeInactive | query | boolean |
|
| search | query | string |
|
| page | query | integer · int32 |
|
| pageSize | query | integer · int32 |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CustomerDto[] |
/api/v1/customers
| Field | Type | Description |
|---|---|---|
| legalName | string? |
|
| customerType | string? |
|
| displayName | string? |
|
| taxId | string? |
|
string? |
||
| phone | string? |
|
| address | string? |
|
| country | string? |
|
| paymentTerms | string? |
|
| creditLimit | number · double? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedCustomerResponse |
/api/v1/customers/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CustomerDto |
/api/v1/customers/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| legalName | string? |
|
| customerType | string? |
|
| displayName | string? |
|
| taxId | string? |
|
string? |
||
| phone | string? |
|
| address | string? |
|
| country | string? |
|
| paymentTerms | string? |
|
| creditLimit | number · double? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/customers/{id}/deactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/customers/{id}/reactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/dashboard/executive
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ExecutiveSummaryDto |
/api/v1/dashboard/me
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RoleDashboardDto |
/api/v1/production-orders/{orderId}/dispatch-clearance
| Name | In | Type | Description |
|---|---|---|---|
| orderId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | DispatchClearance |
/api/v1/dispatch-orders
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| productionOrderIds | string · uuid[]? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | DispatchedOrder |
/api/v1/dispatch-orders/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | DispatchOrderDto |
/api/v1/dispatch-orders/{id}/checklist
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| description | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedChecklistItem |
/api/v1/dispatch-orders/{id}/checklist/{itemId}/complete
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
|
| itemId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/dispatch-orders/{id}/deliver
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| arrivals | UnitArrival[]? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/dispatch-orders/{id}/load
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| vehicleId | string · uuid |
|
| driverId | string · uuid |
|
| loadedUnitIds | string · uuid[]? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/drawings
| Name | In | Type | Description |
|---|---|---|---|
| contractId | query | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | DrawingDto[] |
/api/v1/drawings
| Field | Type | Description |
|---|---|---|
| contractId | string · uuid |
|
| drawingNumber | string? |
|
| title | string? |
|
| discipline | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedDrawingResponse |
/api/v1/drawings/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | DrawingDto |
/api/v1/drawings/{id}/release
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| rowVersion | integer · int32 |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/drawings/{id}/release-check
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ReleaseCheckResponse |
/api/v1/drawings/{id}/revise
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| title | string? |
|
| discipline | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedDrawingResponse |
/api/v1/drawings/{id}/submit
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/drivers
| Field | Type | Description |
|---|---|---|
| name | string? |
|
| licenseNumber | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedResponse |
/api/v1/drivers/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | DriverDto |
/api/v1/employees
| Name | In | Type | Description |
|---|---|---|---|
| includeInactive | query | boolean |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EmployeeDto[] |
/api/v1/employees
| Field | Type | Description |
|---|---|---|
| firstName | string? |
|
| lastName | string? |
|
| nationalId | string? |
|
| contractType | string? |
|
| joinDate | string · date-time |
|
| visaNumber | string? |
|
| visaExpiry | string · date-time? |
|
| sponsor | string? |
|
| departmentId | string · uuid? |
|
| managerId | string · uuid? |
|
| userId | string · uuid? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedEmployee |
/api/v1/employees/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EmployeeDto |
/api/v1/employees/{id}/compensation
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| baseSalary | number · double? |
|
| allowances | number · double? |
|
| bankAccount | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/employees/{id}/deactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/environment/aspects
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalAspectDto[] |
/api/v1/environment/aspects
| Field | Type | Description |
|---|---|---|
| activity | string? |
|
| aspect | string? |
|
| impact | string? |
|
| significance | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedAspectResponse |
/api/v1/environment/aspects/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalAspectDto |
/api/v1/environment/incidents
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| category | string? |
|
| severity | string? |
|
| title | string? |
|
| note | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RaisedEnvironmentalIncident |
/api/v1/environment/incidents/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalIncidentDto |
/api/v1/environment/inductions
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalInductionDto[] |
/api/v1/environment/inductions
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| personName | string? |
|
| isSubcontractor | boolean |
|
| topic | string? |
|
| inductedOn | string · date |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RegisteredInductionResponse |
/api/v1/environment/inductions/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalInductionDto |
/api/v1/environment/monitoring
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalReadingDto[] |
/api/v1/environment/monitoring
| Field | Type | Description |
|---|---|---|
| metric | string? |
|
| value | number · double |
|
| periodStart | string · date |
|
| periodEnd | string · date |
|
| machineId | string · uuid? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RecordedReadingResponse |
/api/v1/environment/monitoring/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalReadingDto |
/api/v1/environment/objectives
| Name | In | Type | Description |
|---|---|---|---|
| periodStart | query | string · date |
|
| periodEnd | query | string · date |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EnvironmentalObjectivesDto |
/api/v1/reports/estimate-vs-actual/{projectId}
| Name | In | Type | Description |
|---|---|---|---|
| projectId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | EstimateVsActualDto |
/api/v1/goods-receipts
| Field | Type | Description |
|---|---|---|
| purchaseOrderId | string · uuid |
|
| quantity | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedGoodsReceiptResponse |
/api/v1/goods-receipts/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | GoodsReceiptDto |
/api/v1/projects/{projectId}/handover
| Name | In | Type | Description |
|---|---|---|---|
| projectId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | HandoverDto |
/api/v1/projects/{projectId}/handover
| Name | In | Type | Description |
|---|---|---|---|
| projectId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | HandoverDto |
/api/v1/environment/hazardous-waste
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | HazardousWasteDisposalDto[] |
/api/v1/environment/hazardous-waste
| Field | Type | Description |
|---|---|---|
| wasteStream | string? |
|
| contractorId | string · uuid |
|
| manifestNumber | string? |
|
| quantityKg | number · double |
|
| disposedOn | string · date |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RecordedDisposalResponse |
/api/v1/environment/hazardous-waste/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | HazardousWasteDisposalDto |
/api/v1/hr/summary
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | HrSummaryDto |
/api/v1/incidents
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| category | string? |
|
| severity | string? |
|
| title | string? |
|
| note | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RaisedIncident |
/api/v1/inductions
| Field | Type | Description |
|---|---|---|
| workerId | string · uuid |
|
| projectId | string · uuid |
|
| validFrom | string · date-time |
|
| validTo | string · date-time |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedInduction |
/api/v1/inductions/authorize
| Field | Type | Description |
|---|---|---|
| workerId | string · uuid |
|
| projectId | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/inductions/check
| Name | In | Type | Description |
|---|---|---|---|
| workerId | query | string · uuid |
|
| projectId | query | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | InductionCheck |
/api/v1/inspection-plans
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| productFamily | string? |
|
| name | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedPlanResponse |
/api/v1/inspection-plans/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | InspectionPlanDto |
/api/v1/inspection-plans/{id}/points
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| stage | string? |
|
| pointType | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedPointResponse |
/api/v1/inspection-plans/{id}/points/{pointId}/checks
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
|
| pointId* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| checkType | string? |
|
| name | string? |
|
| lowerTolerance | number · double? |
|
| upperTolerance | number · double? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedCheckResponse |
/api/v1/inspections
| Field | Type | Description |
|---|---|---|
| productionOrderId | string · uuid |
|
| planId | string · uuid |
|
| stage | string? |
|
| result | string? |
|
| evidenceRef | string? |
|
| readings | InspectionReadingInput[]? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RecordedInspection |
/api/v1/inspections/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | InspectionDto |
/api/v1/installations/{productionOrderId}
| Name | In | Type | Description |
|---|---|---|---|
| productionOrderId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | InstallationDto |
/api/v1/installations/advance
| Field | Type | Description |
|---|---|---|
| productionOrderId | string · uuid |
|
| stage | string? |
|
| photoEvidenceRef | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | InstallationDto |
/api/v1/inventory/adjustments
| Field | Type | Description |
|---|---|---|
| materialId | string · uuid |
|
| quantityDelta | number · double |
|
| reason | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedAdjustmentResponse |
/api/v1/inventory/adjustments/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | StockAdjustmentDto |
/api/v1/inventory/adjustments/{id}/apply
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/inventory/cycle-counts
| Field | Type | Description |
|---|---|---|
| materialId | string · uuid |
|
| countedQuantity | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CycleCountResult |
/api/v1/job-cards
| Field | Type | Description |
|---|---|---|
| productionOrderId | string · uuid |
|
| sequence | integer · int32 |
|
| operation | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedJobCardResponse |
/api/v1/job-cards/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | JobCardDto |
/api/v1/job-cards/{id}/complete
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/job-cards/{id}/scrap
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| quantity | number · double |
|
| reasonCode | string? |
|
| note | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RecordedScrapResponse |
/api/v1/job-cards/{id}/start
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/leads
| Name | In | Type | Description |
|---|---|---|---|
| source | query | string |
|
| stage | query | string |
|
| ownerId | query | string · uuid |
|
| includeInactive | query | boolean |
|
| page | query | integer · int32 |
|
| pageSize | query | integer · int32 |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | LeadDto[] |
/api/v1/leads
| Field | Type | Description |
|---|---|---|
| customerId | string · uuid |
|
| firstName | string? |
|
| lastName | string? |
|
| source | string? |
|
| phone | string? |
|
| workPhone | string? |
|
string? |
||
string? |
||
| jobTitle | string? |
|
| nationality | string? |
|
| scopeOfWorkInterest | string? |
|
| priority | string? |
|
| ownerId | string · uuid? |
|
| notes | string? |
|
| doNotFollowUp | boolean |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedLeadResponse |
/api/v1/leads/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | LeadDto |
/api/v1/leads/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| customerId | string · uuid |
|
| firstName | string? |
|
| lastName | string? |
|
| source | string? |
|
| phone | string? |
|
| workPhone | string? |
|
string? |
||
string? |
||
| jobTitle | string? |
|
| nationality | string? |
|
| scopeOfWorkInterest | string? |
|
| priority | string? |
|
| ownerId | string · uuid? |
|
| notes | string? |
|
| doNotFollowUp | boolean |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/leads/{id}/activities
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| type | string? |
|
| note | string? |
|
| outcome | string? |
|
| nextFollowUpDate | string · date? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/leads/{id}/assign
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| ownerId | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/leads/{id}/convert
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/leads/{id}/stage
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| toStage | string? |
|
| rowVersion | integer · int32 |
|
| reason | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/leave/balances
| Name | In | Type | Description |
|---|---|---|---|
| employeeId | query | string · uuid |
|
| leaveType | query | string |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | BalanceResponse |
/api/v1/leave/balances
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| leaveType | string? |
|
| days | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/leave/requests
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| leaveType | string? |
|
| startDate | string · date |
|
| endDate | string · date |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RaisedLeave |
/api/v1/leave/requests/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | LeaveRequestDto |
/api/v1/leave/requests/{id}/apply
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/machines
| Name | In | Type | Description |
|---|---|---|---|
| includeInactive | query | boolean |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | MachineDto[] |
/api/v1/machines
| Field | Type | Description |
|---|---|---|
| assetCode | string? |
|
| name | string? |
|
| capacity | number · double? |
|
| calibrationDue | string · date-time? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedMachineResponse |
/api/v1/machines/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | MachineDto |
/api/v1/machines/{id}/assignable
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | AssignableResponse |
/api/v1/machines/{id}/deactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/machines/{id}/downtime
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| reasonCode | string? |
|
| note | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | StartedDowntimeResponse |
/api/v1/machines/{id}/downtime/stop
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/maintenance/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | WorkOrderDto |
/api/v1/maintenance/{id}/close
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| resolutionNote | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/maintenance/breakdown/{breakdownTicketId}
| Name | In | Type | Description |
|---|---|---|---|
| breakdownTicketId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedWorkOrderResponse |
/api/v1/maintenance/preventive/{machineId}
| Name | In | Type | Description |
|---|---|---|---|
| machineId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedWorkOrderResponse |
/api/v1/materials
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | MaterialDto[] |
/api/v1/materials
| Field | Type | Description |
|---|---|---|
| code | string? |
|
| name | string? |
|
| unitOfMeasure | string? |
|
| category | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedMaterialResponse |
/api/v1/materials/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | MaterialDto |
/api/v1/materials/{id}/deactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/materials/{id}/reactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/materials/{id}/receive
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| quantity | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/ncrs
| Field | Type | Description |
|---|---|---|
| productionOrderId | string · uuid |
|
| inspectionId | string · uuid? |
|
| supplierId | string · uuid? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedNcrResponse |
/api/v1/ncrs/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | NcrDto |
/api/v1/ncrs/{id}/close
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | NcrDto |
/api/v1/ncrs/{id}/disposition
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| disposition | string? |
|
| causeCode | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | NcrDto |
/api/v1/leads/{leadId}/nonconformities
| Name | In | Type | Description |
|---|---|---|---|
| leadId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | NonconformityDto[] |
/api/v1/leads/{leadId}/nonconformities/{id}/status
| Name | In | Type | Description |
|---|---|---|---|
| leadId* | path | string · uuid |
|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| toStatus | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/oee/production-orders/{productionOrderId}
| Name | In | Type | Description |
|---|---|---|---|
| productionOrderId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | OeeReportDto |
/api/v1/overtime
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| workDate | string · date |
|
| hours | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CapturedOvertime |
/api/v1/overtime/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | OvertimeDto |
/api/v1/payroll/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | PayrollRunDto |
/api/v1/payroll/runs
| Field | Type | Description |
|---|---|---|
| period | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | PayrollRunResult |
/api/v1/payroll/runs/{id}/post
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/permits
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| workType | string? |
|
| validFrom | string · date-time |
|
| validTo | string · date-time |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedPermit |
/api/v1/permits/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | PermitDto |
/api/v1/permits/check
| Name | In | Type | Description |
|---|---|---|---|
| projectId | query | string · uuid |
|
| workType | query | string |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | PermitCheck |
/api/v1/portal/projects
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | PortalProjectDto[] |
/api/v1/portal/quotations
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | PortalQuotationDto[] |
/api/v1/portal/quotations/{id}/accept
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/production-orders
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| drawingId | string · uuid |
|
| reservationId | string · uuid |
|
| machineId | string · uuid |
|
| operatorId | string · uuid |
|
| requiredCertification | string? |
|
| quantity | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedProductionOrderResponse |
/api/v1/production-orders/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ProductionOrderDto |
/api/v1/production-orders/{id}/complete
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/reports/profitability/{projectId}
| Name | In | Type | Description |
|---|---|---|---|
| projectId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ProjectProfitabilityDto |
/api/v1/projects
| Name | In | Type | Description |
|---|---|---|---|
| contractId | query | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ProjectBaselineDto[] |
/api/v1/projects
| Field | Type | Description |
|---|---|---|
| contractId | string · uuid |
|
| plannedStart | string · date |
|
| plannedEnd | string · date |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedProjectBaselineResponse |
/api/v1/projects/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ProjectBaselineDto |
/api/v1/projects/{id}/budget-lines
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| category | string? |
|
| estimatedAmount | number · double |
|
| note | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedBudgetLineResponse |
/api/v1/projects/{id}/lock
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/projects/{id}/milestones
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| name | string? |
|
| plannedDate | string · date |
|
| weight | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedMilestoneResponse |
/api/v1/projects/{id}/submit
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/projects/milestones/{milestoneId}/complete
| Name | In | Type | Description |
|---|---|---|---|
| milestoneId* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| actualDate | string · date |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/purchase-orders
| Field | Type | Description |
|---|---|---|
| awardedBidId | string · uuid |
|
| avlOverrideReason | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedPurchaseOrderResponse |
/api/v1/purchase-orders/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | PurchaseOrderDto |
/api/v1/purchase-orders/{id}/send
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/purchase-orders/{id}/submit
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/quality/reports/first-pass-yield
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | FirstPassYieldReport |
/api/v1/quotations
| Name | In | Type | Description |
|---|---|---|---|
| leadId | query | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | QuotationDto[] |
/api/v1/quotations
| Field | Type | Description |
|---|---|---|
| leadId | string · uuid |
|
| totalAmount | number · double |
|
| marginPct | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedQuotation |
/api/v1/quotations/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | QuotationDto |
/api/v1/quotations/{id}/revise
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| totalAmount | number · double |
|
| marginPct | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedRevision |
/api/v1/quotations/{id}/send
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/quotations/{id}/submit
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/receipts
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| amount | number · double |
|
| method | string? |
|
| receivedOn | string · date |
|
| reference | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ReceiptResult |
/api/v1/receipts/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ReceiptDto |
/api/v1/receipts/project/{projectId}
| Name | In | Type | Description |
|---|---|---|---|
| projectId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ReceiptDto[] |
/api/v1/reorder/check
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| materialId | string · uuid |
|
| estimatedUnitCost | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ReorderResult |
/api/v1/reorder/policy/{materialId}
| Name | In | Type | Description |
|---|---|---|---|
| materialId* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| reorderPoint | number · double |
|
| minQuantity | number · double |
|
| maxQuantity | number · double |
|
| abcClass | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/requisitions/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RequisitionDto |
/api/v1/requisitions/check-shortfall
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| materialId | string · uuid |
|
| requiredQuantity | number · double |
|
| estimatedUnitCost | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ShortfallResult |
/api/v1/reservations
| Field | Type | Description |
|---|---|---|
| materialId | string · uuid |
|
| drawingId | string · uuid |
|
| quantity | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedReservationResponse |
/api/v1/reservations/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ReservationDto |
/api/v1/reservations/{id}/release
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/rfqs
| Field | Type | Description |
|---|---|---|
| requisitionId | string · uuid |
|
| supplierIds | string · uuid[]? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedRfqResponse |
/api/v1/rfqs/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RfqDto |
/api/v1/roles
| Field | Type | Description |
|---|---|---|
| name | string? |
|
| description | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedRoleResponse |
/api/v1/roles/{id}/permissions
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| permissionCodes | string[]? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/service/reports/summary
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ServiceSummaryDto |
/api/v1/service-tickets
| Field | Type | Description |
|---|---|---|
| productionOrderId | string · uuid |
|
| source | string? |
|
| title | string? |
|
| description | string? |
|
| severity | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RaisedServiceTicket |
/api/v1/service-tickets/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | ServiceTicketDto |
/api/v1/snags
| Name | In | Type | Description |
|---|---|---|---|
| projectId | query | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SnagDto[] |
/api/v1/snags
| Field | Type | Description |
|---|---|---|
| projectId | string · uuid |
|
| title | string? |
|
| description | string? |
|
| severity | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | RaisedSnag |
/api/v1/storage/download-url
| Field | Type | Description |
|---|---|---|
| key | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | DownloadTicket |
/api/v1/storage/upload-url
| Field | Type | Description |
|---|---|---|
| category | string? |
|
| fileName | string? |
|
| contentType | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | UploadTicket |
/api/v1/supplier-invoices
| Field | Type | Description |
|---|---|---|
| purchaseOrderId | string · uuid |
|
| invoiceNumber | string? |
|
| invoicedQuantity | number · double |
|
| invoicedUnitPrice | number · double |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | MatchResult |
/api/v1/supplier-invoices/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SupplierInvoiceDto |
/api/v1/suppliers
| Name | In | Type | Description |
|---|---|---|---|
| includeInactive | query | boolean |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SupplierDto[] |
/api/v1/suppliers
| Field | Type | Description |
|---|---|---|
| legalName | string? |
|
| taxRegistration | string? |
|
| contactEmail | string? |
|
| contactPhone | string? |
|
| paymentTerms | string? |
|
| isApprovedVendor | boolean |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedSupplierResponse |
/api/v1/suppliers/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SupplierDto |
/api/v1/suppliers/{id}/deactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/suppliers/{id}/reactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/suppliers/{id}/scorecard
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SupplierScorecardDto |
/api/v1/tickets
| Field | Type | Description |
|---|---|---|
| ticketType | string? |
|
| title | string? |
|
| description | string? |
|
| severity | string? |
|
| subjectType | string? |
|
| subjectId | string · uuid? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedTicket |
/api/v1/tickets/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TicketDto |
/api/v1/tickets/{id}/assign
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| assigneeUserId | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TicketDto |
/api/v1/tickets/{id}/close
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| verificationNote | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TicketDto |
/api/v1/tickets/{id}/resolve
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| resolutionNote | string? |
|
| evidenceRef | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TicketDto |
/api/v1/timesheets
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| workDate | string · date |
|
| allocations | AllocationInput[]? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SubmittedTimesheet |
/api/v1/timesheets/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TimesheetDto |
/api/v1/training/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TrainingRecordDto |
/api/v1/training/complete
| Field | Type | Description |
|---|---|---|
| employeeId | string · uuid |
|
| competencyCode | string? |
|
| title | string? |
|
| completedOn | string · date-time |
|
| validTo | string · date-time? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TrainingResult |
/api/v1/training/employee/{employeeId}
| Name | In | Type | Description |
|---|---|---|---|
| employeeId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | TrainingRecordDto[] |
/api/v1/users/{id}/deactivate
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/users/{id}/roles
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Field | Type | Description |
|---|---|---|
| roleId | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/users/{id}/roles/{roleId}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
|
| roleId* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | — |
/api/v1/vehicles
| Field | Type | Description |
|---|---|---|
| plateNumber | string? |
|
| description | string? |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | CreatedResponse |
/api/v1/vehicles/{id}
| Name | In | Type | Description |
|---|---|---|---|
| id* | path | string · uuid |
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | VehicleDto |
No endpoints match your search.