{ "openapi": "3.1.0", "info": { "title": "Horixa API", "version": "2.0", "description": "Publieke REST API van Horixa. Authenticatie via `Authorization: Bearer hx_live_...` API-keys met scopes. Rate limit: 120 requests per minuut per key.", "contact": { "url": "https://horixa.nl/developers" } }, "servers": [ { "url": "https://horixa.nl/api/v2" } ], "paths": { "/crm/organization": { "get": { "tags": [ "CRM" ], "summary": "Lijst organizations", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "crm:read" }, "post": { "tags": [ "CRM" ], "summary": "Maak organization", "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Organization" } } } } } }, "400": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "crm:write" } }, "/crm/organization/{id}": { "get": { "tags": [ "CRM" ], "summary": "Organisatie op id", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Organization" } } } } } }, "404": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "crm:read" } }, "/crm/person": { "get": { "tags": [ "CRM" ], "summary": "Lijst persons", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "crm:read" }, "post": { "tags": [ "CRM" ], "summary": "Maak person", "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Person" } } } } } }, "400": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "crm:write" } }, "/projects/project": { "get": { "tags": [ "Projecten" ], "summary": "Lijst projects", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "projects:read" }, "post": { "tags": [ "Projecten" ], "summary": "Maak project", "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "projects:write" } }, "/hours/hours": { "get": { "tags": [ "Uren" ], "summary": "Lijst hourss", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Hours" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "hours:read" }, "post": { "tags": [ "Uren" ], "summary": "Maak hours", "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HoursCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Hours" } } } } } }, "400": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "hours:write" } }, "/projects/service": { "get": { "tags": [ "Projecten" ], "summary": "Lijst diensten", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectService" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "projects:read" } }, "/hours/hourstype": { "get": { "tags": [ "Uren" ], "summary": "Lijst uursoorten", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HourType" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "hours:read" } }, "/hrm/employee": { "get": { "tags": [ "HRM" ], "summary": "Lijst medewerkers", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "hrm:read" } }, "/sales/sales": { "get": { "tags": [ "Sales" ], "summary": "Lijst verkoopkansen", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOpportunity" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "sales:read" } }, "/hrm/leave": { "get": { "tags": [ "HRM" ], "summary": "Lijst verlofaanvragen", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LeaveRequest" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "hrm:read" } }, "/invoices/invoice": { "get": { "tags": [ "Facturatie" ], "summary": "Lijst facturen", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "meta": { "$ref": "#/components/schemas/ListMeta" } } } } } }, "401": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "invoices:read" } }, "/invoices/invoice/{id}": { "get": { "tags": [ "Facturatie" ], "summary": "Factuur op id, inclusief regels", "security": [ { "apiKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Invoice" } } } } } }, "404": { "description": "Fout (RFC 7807)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scope": "invoices:read" } } }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "hx_live_..." } }, "schemas": { "ListMeta": { "type": "object", "properties": { "count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } }, "Problem": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" } } }, "ListQuery": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 }, "offset": { "type": "integer", "minimum": 0, "default": 0 }, "sort": { "type": "string" } }, "additionalProperties": false }, "OrganizationCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "coc_code": { "type": "string", "maxLength": 20, "nullable": true }, "vat_number": { "type": "string", "maxLength": 30, "nullable": true }, "relation_number": { "type": "string", "maxLength": 50, "nullable": true }, "industry": { "type": "string", "maxLength": 100, "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "maxLength": 40, "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "address": { "type": "object", "properties": { "line1": { "type": "string" }, "postal_code": { "type": "string" }, "locality": { "type": "string" }, "country": { "type": "string" } }, "additionalProperties": false, "nullable": true }, "note": { "type": "string", "maxLength": 10000, "nullable": true } }, "required": [ "name" ], "additionalProperties": false }, "PersonCreate": { "type": "object", "properties": { "first_name": { "type": "string", "maxLength": 100, "nullable": true }, "last_name": { "type": "string", "minLength": 1, "maxLength": 150 }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "maxLength": 40, "nullable": true }, "note": { "type": "string", "maxLength": 10000, "nullable": true } }, "required": [ "last_name" ], "additionalProperties": false }, "ProjectCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "organization_id": { "type": "string", "format": "uuid", "nullable": true }, "person_id": { "allOf": [ { "$ref": "#/properties/organization_id" } ], "nullable": true }, "manager_employee_id": { "allOf": [ { "$ref": "#/properties/organization_id" } ], "nullable": true }, "status": { "type": "string", "enum": [ "active", "closed", "archived" ], "default": "active" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "budget_minutes": { "type": "integer", "minimum": 0, "nullable": true }, "budget_amount": { "type": "number", "minimum": 0, "nullable": true }, "note": { "type": "string", "maxLength": 10000, "nullable": true } }, "required": [ "name" ], "additionalProperties": false }, "HoursCreate": { "type": "object", "properties": { "employee_id": { "type": "string", "format": "uuid" }, "project_id": { "allOf": [ { "$ref": "#/properties/employee_id" } ], "nullable": true }, "service_id": { "allOf": [ { "$ref": "#/properties/employee_id" } ], "nullable": true }, "hour_type_id": { "allOf": [ { "$ref": "#/properties/employee_id" } ], "nullable": true }, "start_at": { "type": "string", "format": "date-time" }, "minutes": { "type": "integer", "minimum": 1, "maximum": 1440 }, "note": { "type": "string", "maxLength": 2000, "nullable": true }, "billable": { "type": "boolean", "default": true } }, "required": [ "employee_id", "start_at", "minutes" ], "additionalProperties": false }, "Organization": { "type": "object", "description": "Organisatie-record", "additionalProperties": true }, "Person": { "type": "object", "description": "Persoon-record", "additionalProperties": true }, "Project": { "type": "object", "description": "Project-record", "additionalProperties": true }, "Hours": { "type": "object", "description": "Uren-record", "additionalProperties": true }, "Invoice": { "type": "object", "description": "Factuur-record (met regels bij detail)", "additionalProperties": true }, "SalesOpportunity": { "type": "object", "description": "Verkoopkans-record", "additionalProperties": true }, "ProjectService": { "type": "object", "description": "Dienst-record", "additionalProperties": true }, "HourType": { "type": "object", "description": "Uursoort-record", "additionalProperties": true }, "Employee": { "type": "object", "description": "Medewerker-record", "additionalProperties": true }, "LeaveRequest": { "type": "object", "description": "Verlofaanvraag-record", "additionalProperties": true } } } }