{ "openapi": "3.0.3", "info": { "title": "Nordlet Accounting API", "version": "0.2.0", "description": "API-first accounting for the EU/EEA market (Lithuania first). Everything the product can do is available here.\n\n## Conventions\n- Every operation is `POST /v1/{module}/{resource}/{action}` with a JSON body.\n- Authenticate with `Authorization: Bearer `. Keys carry scopes like `sales:write` or `*`.\n- List actions accept `page`, `pageSize`, `sort: [{field, dir}]` and `filter: [{field, op, value}]`.\n- Monetary amounts are decimal **strings** (e.g. `\"121.0000\"`), never floats.\n- Errors share one envelope: `{ \"error\": { \"code\", \"message\", \"requestId\", \"fieldErrors?\" } }`.\n- Country-specific compliance endpoints are namespaced by jurisdiction (e.g. `/v1/declarations/lt/...`)\n and return 422 unless the company is registered in that country (set at `account/companies/create`).\n\n## Idempotency\nSend an `Idempotency-Key` header on any mutating call. Retries replay the original response\n(marked with `x-idempotent-replay: true`); reusing a key with a different payload returns 422.\n\n## Rate limits\n300 requests/min per API key by default. 429 responses include a `retry-after` header.\n\n## Webhooks\nSubscribe via `webhooks/subscriptions/create`. Deliveries are HMAC-signed\n(`x-nordlet-signature: sha256=`) and retried with exponential backoff.\n\nGuides — getting started, SDKs, conventions, bank imports, EU VAT, revenue recognition,\nconsolidation — live at ." }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer" } }, "schemas": { "ErrorResponse": { "type": "object", "required": [ "error" ], "additionalProperties": false, "properties": { "error": { "type": "object", "required": [ "code", "message", "requestId" ], "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "validation", "unauthorized", "forbidden", "not_found", "conflict", "idempotency_key_reuse", "idempotency_in_progress", "rate_limited", "internal" ] }, "message": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "requestId": { "type": "string", "maxLength": 64, "pattern": "^[a-zA-Z0-9_-]+$" }, "fieldErrors": { "type": "object", "maxProperties": 100, "additionalProperties": { "type": "array", "maxItems": 100, "items": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } } } } } } } } }, "paths": { "/v1/reference/exchange-rates/sync": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "imported": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "date", "imported" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/exchange-rates/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rate": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "currencyCode", "date", "rate" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/exchange-rates/set": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "rate": { "type": "string", "pattern": "^\\d{1,10}(\\.\\d{1,8})?$" } }, "required": [ "currency", "date", "rate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rate": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "currencyCode", "date", "rate" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/exchange-rates/overrides/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rate": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "currencyCode", "date", "rate" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/exchange-rates/overrides/delete": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "currency", "date" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/countries/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isEu": { "type": "boolean" }, "isEea": { "type": "boolean" }, "names": { "type": "object", "properties": { "lt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "en": { "type": "string", "pattern": "^[\\s\\S]*$" }, "ru": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "lt", "en", "ru" ], "additionalProperties": false } }, "required": [ "code", "isEu", "isEea", "names" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/banks/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "bic": { "type": "string", "pattern": "^[\\s\\S]*$" }, "bankCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" } }, "required": [ "id", "countryCode", "name", "bic", "bankCode", "isActive" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/banks/upsert": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "bic": { "type": "string", "minLength": 8, "maxLength": 11, "pattern": "^[\\s\\S]*$" }, "bankCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" } }, "required": [ "countryCode", "name", "bic" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "bic": { "type": "string", "pattern": "^[\\s\\S]*$" }, "bankCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" } }, "required": [ "id", "countryCode", "name", "bic", "bankCode", "isActive" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/lt/regions/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isoCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "isoCode", "name" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/currencies/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "minorUnits": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "code", "name", "minorUnits" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/vat-classifiers/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "ratePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "countryCode", "name", "ratePercent" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/vat-classifiers/upsert": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "minItems": 1, "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "default": "LT", "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 600, "pattern": "^[\\s\\S]*$" }, "ratePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "code", "name" ] } } }, "required": [ "rows" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "upserted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "upserted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/eu-vat-rates/list": { "post": { "tags": [ "reference" ], "description": "Effective EU VAT rate mapping for this company: EC TEDB defaults, replaced per country by any company overrides. Verify the mapping fits the goods and services you sell before relying on it.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "notice": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "category": { "type": "string", "enum": [ "standard", "reduced", "super_reduced", "parking" ] }, "ratePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "validFrom": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "validTo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "source": { "type": "string", "enum": [ "default", "company" ] } }, "required": [ "countryCode", "category", "ratePercent", "validFrom", "validTo", "source" ], "additionalProperties": false } } }, "required": [ "notice", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/eu-vat-rates/set-overrides": { "post": { "tags": [ "reference" ], "description": "Replace the VAT rate mapping this company uses for one EU country. Pass an empty rates array to drop the overrides and return to the TEDB defaults. Overrides feed rate suggestions (vat/resolve) and OSS/IOSS return rate classification.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "rates": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "standard", "reduced", "super_reduced", "parking" ] }, "ratePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "category", "ratePercent" ] } } }, "required": [ "countryCode", "rates" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "source": { "type": "string", "enum": [ "default", "company" ] }, "notice": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "standard", "reduced", "super_reduced", "parking" ] }, "ratePercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "category", "ratePercent" ], "additionalProperties": false } } }, "required": [ "countryCode", "source", "notice", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/vat/resolve": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "customerCountryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "customerIsBusiness": { "type": "boolean" }, "supplyType": { "default": "goods", "type": "string", "enum": [ "goods", "services", "digital" ] }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "belowDistanceSalesThreshold": { "type": "boolean" }, "facilitatedByMarketplace": { "type": "boolean" }, "actingAsMarketplace": { "type": "boolean" }, "sellerEstablishedInEu": { "type": "boolean" }, "importedConsignmentValueEur": { "type": "string", "pattern": "^\\d{1,12}(\\.\\d{1,4})?$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scheme": { "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "reverseCharge": { "type": "boolean" }, "deemedSupplier": { "type": "boolean" }, "zeroRated": { "type": "boolean" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "standard", "reduced", "super_reduced", "parking" ] }, "ratePercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "category", "ratePercent" ], "additionalProperties": false } }, "legalBasis": { "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "scheme", "vatCountryCode", "reverseCharge", "deemedSupplier", "zeroRated", "rates", "legalBasis", "notes" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/cn-codes/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "nameLt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "nameLt", "supplementaryUnit" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/cn-codes/upsert": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "minItems": 1, "maxItems": 2000, "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^\\d{8}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 600, "pattern": "^[\\s\\S]*$" }, "nameLt": { "type": "string", "minLength": 1, "maxLength": 600, "pattern": "^[\\s\\S]*$" }, "supplementaryUnit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name" ] } } }, "required": [ "rows" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "upserted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "upserted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/compliance-versions/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "country": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "pattern": "^[\\s\\S]*$" }, "system": { "type": "string", "pattern": "^[\\s\\S]*$" }, "artifact": { "type": "string", "pattern": "^[\\s\\S]*$" }, "version": { "type": "string", "pattern": "^[\\s\\S]*$" }, "verifiedOn": { "type": "string", "pattern": "^[\\s\\S]*$" }, "source": { "type": "string", "pattern": "^[\\s\\S]*$" }, "resource": { "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "country", "system", "artifact", "version", "verifiedOn", "source" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/intrastat-thresholds/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "arrivalsReporting": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchesReporting": { "type": "string", "pattern": "^[\\s\\S]*$" }, "arrivalsStatistical": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchesStatistical": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "year", "arrivalsReporting", "dispatchesReporting", "arrivalsStatistical", "dispatchesStatistical" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/units/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "nameLt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "nameEn": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "nameLt", "nameEn" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/series/create": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentType": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "prefix": { "default": "", "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "startAt": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "documentType", "year" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "documentType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "prefix": { "type": "string", "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "nextNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "documentType", "prefix", "year", "nextNumber", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reference/series/list": { "post": { "tags": [ "reference" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "documentType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "prefix": { "type": "string", "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "nextNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "documentType", "prefix", "year", "nextNumber", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/addresses/create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "default": "billing", "type": "string", "enum": [ "billing", "shipping", "registered", "other" ] }, "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "isDefault": { "default": false, "type": "boolean" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "partnerId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "pattern": "^[\\s\\S]*$" }, "street": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "city": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "postalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "countryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "type", "street", "city", "postalCode", "countryCode", "isDefault", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/addresses/update": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "billing", "shipping", "registered", "other" ] }, "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "pattern": "^[\\s\\S]*$" }, "street": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "city": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "postalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "countryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "type", "street", "city", "postalCode", "countryCode", "isDefault", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/addresses/delete": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/addresses/list": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "pattern": "^[\\s\\S]*$" }, "street": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "city": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "postalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "countryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "type", "street", "city", "postalCode", "countryCode", "isDefault", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/contacts/create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 1000, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "name", "partnerId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "name", "role", "email", "phone", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/contacts/update": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 1000, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "name", "role", "email", "phone", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/contacts/delete": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/contacts/list": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "name", "role", "email", "phone", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/bank-accounts/create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "iban": { "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "bankName": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "bic": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "currency": { "default": "EUR", "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "isDefault": { "default": false, "type": "boolean" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "iban", "partnerId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "iban": { "type": "string", "pattern": "^[\\s\\S]*$" }, "bankName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "bic": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "iban", "bankName", "bic", "currency", "isDefault", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/bank-accounts/update": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "iban": { "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "bankName": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "bic": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "iban": { "type": "string", "pattern": "^[\\s\\S]*$" }, "bankName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "bic": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "iban", "bankName", "bic", "currency", "isDefault", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/bank-accounts/delete": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/bank-accounts/list": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "iban": { "type": "string", "pattern": "^[\\s\\S]*$" }, "bankName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "bic": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "iban", "bankName", "bic", "currency", "isDefault", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/validate-vat": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vatCode": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "requestIdentifier": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "checkedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "valid", "countryCode", "vatNumber", "name", "address", "requestIdentifier", "checkedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "default": "company", "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "vatCode": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "peppolId": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "birthDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "isCustomer": { "default": true, "type": "boolean" }, "isSupplier": { "default": false, "type": "boolean" }, "paymentTermDays": { "type": "integer", "minimum": 0, "maximum": 730, "format": "int64" }, "creditLimit": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "priceListId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "peppolId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "paymentTermDays": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "creditLimit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "priceListId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatValid": { "nullable": true, "type": "boolean" }, "vatValidatedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "vatCode", "peppolId", "email", "phone", "selfEmploymentCertNo", "birthDate", "isCustomer", "isSupplier", "paymentTermDays", "creditLimit", "priceListId", "groupId", "statusId", "vatValid", "vatValidatedAt", "address", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/find-or-create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "default": "company", "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "vatCode": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "peppolId": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "birthDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "isCustomer": { "default": true, "type": "boolean" }, "isSupplier": { "default": false, "type": "boolean" }, "paymentTermDays": { "type": "integer", "minimum": 0, "maximum": 730, "format": "int64" }, "creditLimit": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "priceListId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "boolean" }, "partner": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "peppolId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "paymentTermDays": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "creditLimit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "priceListId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatValid": { "nullable": true, "type": "boolean" }, "vatValidatedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "vatCode", "peppolId", "email", "phone", "selfEmploymentCertNo", "birthDate", "isCustomer", "isSupplier", "paymentTermDays", "creditLimit", "priceListId", "groupId", "statusId", "vatValid", "vatValidatedAt", "address", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "created", "partner" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/get": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "peppolId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "paymentTermDays": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "creditLimit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "priceListId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatValid": { "nullable": true, "type": "boolean" }, "vatValidatedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "vatCode", "peppolId", "email", "phone", "selfEmploymentCertNo", "birthDate", "isCustomer", "isSupplier", "paymentTermDays", "creditLimit", "priceListId", "groupId", "statusId", "vatValid", "vatValidatedAt", "address", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/update": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "vatCode": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "peppolId": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "birthDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "paymentTermDays": { "type": "integer", "minimum": 0, "maximum": 730, "format": "int64" }, "creditLimit": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "priceListId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "peppolId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "paymentTermDays": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "creditLimit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "priceListId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatValid": { "nullable": true, "type": "boolean" }, "vatValidatedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "vatCode", "peppolId", "email", "phone", "selfEmploymentCertNo", "birthDate", "isCustomer", "isSupplier", "paymentTermDays", "creditLimit", "priceListId", "groupId", "statusId", "vatValid", "vatValidatedAt", "address", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/delete": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/list": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "company", "person" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "peppolId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "selfEmploymentCertNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "paymentTermDays": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "creditLimit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "priceListId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "statusId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatValid": { "nullable": true, "type": "boolean" }, "vatValidatedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "vatCode", "peppolId", "email", "phone", "selfEmploymentCertNo", "birthDate", "isCustomer", "isSupplier", "paymentTermDays", "creditLimit", "priceListId", "groupId", "statusId", "vatValid", "vatValidatedAt", "address", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/groups/create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/groups/update": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/groups/delete": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/groups/list": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "createdAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/statuses/create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "sortOrder": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000, "format": "int64" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "sortOrder", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/statuses/update": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": 0, "maximum": 10000, "format": "int64" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "sortOrder", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/statuses/delete": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/statuses/list": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "sortOrder", "createdAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/inquiries/create": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contactName": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "contactEmail": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "contactPhone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "subject": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "body": { "type": "string", "maxLength": 10000, "pattern": "^[\\s\\S]*$" }, "channel": { "default": "other", "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "assignedUserId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 10000, "pattern": "^[\\s\\S]*$" } }, "required": [ "subject" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactEmail": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactPhone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "subject": { "type": "string", "pattern": "^[\\s\\S]*$" }, "body": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "in_progress", "closed" ] }, "assignedUserId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "partnerName", "contactName", "contactEmail", "contactPhone", "subject", "body", "channel", "status", "assignedUserId", "notes", "createdAt", "updatedAt", "closedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/inquiries/update": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "subject": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "body": { "type": "string", "maxLength": 10000, "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "in_progress", "closed" ] }, "assignedUserId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 10000, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactEmail": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactPhone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "subject": { "type": "string", "pattern": "^[\\s\\S]*$" }, "body": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "in_progress", "closed" ] }, "assignedUserId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "partnerName", "contactName", "contactEmail", "contactPhone", "subject", "body", "channel", "status", "assignedUserId", "notes", "createdAt", "updatedAt", "closedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/inquiries/get": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactEmail": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactPhone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "subject": { "type": "string", "pattern": "^[\\s\\S]*$" }, "body": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "in_progress", "closed" ] }, "assignedUserId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "partnerName", "contactName", "contactEmail", "contactPhone", "subject", "body", "channel", "status", "assignedUserId", "notes", "createdAt", "updatedAt", "closedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/inquiries/list": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactEmail": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "contactPhone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "subject": { "type": "string", "pattern": "^[\\s\\S]*$" }, "body": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "in_progress", "closed" ] }, "assignedUserId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "partnerName", "contactName", "contactEmail", "contactPhone", "subject", "body", "channel", "status", "assignedUserId", "notes", "createdAt", "updatedAt", "closedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/partners/credit-check": { "post": { "tags": [ "partners" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "additionalAmount": { "default": "0", "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } }, "required": [ "partnerId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "creditLimit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "openReceivables": { "type": "string", "pattern": "^[\\s\\S]*$" }, "additionalAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalExposure": { "type": "string", "pattern": "^[\\s\\S]*$" }, "available": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "exceeded": { "type": "boolean" } }, "required": [ "partnerId", "partnerName", "creditLimit", "openReceivables", "additionalAmount", "totalExposure", "available", "exceeded" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/create": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "default": "product", "type": "string", "enum": [ "product", "service", "set" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "barcode": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "unit": { "default": "vnt", "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "salePriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "purchasePriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "cnCode": { "type": "string", "pattern": "^\\d{8}$" }, "originCountry": { "type": "string", "pattern": "^[A-Z]{2}$" }, "netMassKg": { "type": "string", "pattern": "^\\d{1,8}(\\.\\d{1,6})?$" }, "supplementaryUnit": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "supplementaryQtyPerUnit": { "type": "string", "pattern": "^\\d{1,8}(\\.\\d{1,6})?$" }, "description": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "attributes": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 }, "translations": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] }, "maxProperties": 100 }, "components": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,9}(\\.\\d{1,3})?$" } }, "required": [ "itemId", "quantity" ] } } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "product", "service", "set" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "barcode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "salePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "purchasePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "cnCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "originCountry": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "netMassKg": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryQtyPerUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "attributes": { "nullable": true, "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 }, "components": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "quantity" ], "additionalProperties": false } }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "barcode", "unit", "vatClassifierCode", "vatRatePercent", "salePriceExclVat", "purchasePriceExclVat", "cnCode", "originCountry", "netMassKg", "supplementaryUnit", "supplementaryQtyPerUnit", "description", "groupId", "attributes", "translations", "components", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/get": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "product", "service", "set" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "barcode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "salePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "purchasePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "cnCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "originCountry": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "netMassKg": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryQtyPerUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "attributes": { "nullable": true, "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 }, "components": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "quantity" ], "additionalProperties": false } }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "barcode", "unit", "vatClassifierCode", "vatRatePercent", "salePriceExclVat", "purchasePriceExclVat", "cnCode", "originCountry", "netMassKg", "supplementaryUnit", "supplementaryQtyPerUnit", "description", "groupId", "attributes", "translations", "components", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/update": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "product", "service", "set" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "barcode": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "salePriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "purchasePriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "cnCode": { "type": "string", "pattern": "^\\d{8}$" }, "originCountry": { "type": "string", "pattern": "^[A-Z]{2}$" }, "netMassKg": { "type": "string", "pattern": "^\\d{1,8}(\\.\\d{1,6})?$" }, "supplementaryUnit": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "supplementaryQtyPerUnit": { "type": "string", "pattern": "^\\d{1,8}(\\.\\d{1,6})?$" }, "description": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "attributes": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 }, "translations": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] }, "maxProperties": 100 }, "components": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,9}(\\.\\d{1,3})?$" } }, "required": [ "itemId", "quantity" ] } } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "product", "service", "set" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "barcode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "salePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "purchasePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "cnCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "originCountry": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "netMassKg": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryQtyPerUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "attributes": { "nullable": true, "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 }, "components": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "quantity" ], "additionalProperties": false } }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "barcode", "unit", "vatClassifierCode", "vatRatePercent", "salePriceExclVat", "purchasePriceExclVat", "cnCode", "originCountry", "netMassKg", "supplementaryUnit", "supplementaryQtyPerUnit", "description", "groupId", "attributes", "translations", "components", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/delete": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/list": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "product", "service", "set" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "barcode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "salePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "purchasePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "cnCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "originCountry": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "netMassKg": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryQtyPerUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "attributes": { "nullable": true, "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 }, "components": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "quantity" ], "additionalProperties": false } }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "barcode", "unit", "vatClassifierCode", "vatRatePercent", "salePriceExclVat", "purchasePriceExclVat", "cnCode", "originCountry", "netMassKg", "supplementaryUnit", "supplementaryQtyPerUnit", "description", "groupId", "attributes", "translations", "components", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/item-groups/create": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "parentId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "parentId", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/item-groups/update": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "parentId", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/item-groups/delete": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/item-groups/list": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "parentId", "createdAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/suppliers/upsert": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "supplierCode": { "type": "string", "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "purchasePriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "partnerId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "supplierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "purchasePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "partnerId", "partnerName", "supplierCode", "purchasePriceExclVat", "currency", "notes", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/suppliers/list": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "supplierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "purchasePriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "partnerId", "partnerName", "supplierCode", "purchasePriceExclVat", "currency", "notes", "updatedAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/items/suppliers/delete": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/price-lists/create": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "currency", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/price-lists/update": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "currency", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/price-lists/list": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "currency", "isActive", "createdAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/price-lists/items/set": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "priceListId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "items": { "minItems": 1, "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } }, "required": [ "itemId", "unitPriceExclVat" ] } } }, "required": [ "priceListId", "items" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "updated" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/price-lists/items/list": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "priceListId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "priceListId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "itemCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "itemCode", "unitPriceExclVat" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/catalog/price-lists/items/delete": { "post": { "tags": [ "catalog" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "priceListId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "priceListId", "itemId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/create": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "default": "invoice", "type": "string", "enum": [ "invoice", "credit_note", "proforma", "advance" ] }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "issueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "creditedInvoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatScheme": { "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "lines": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "quantity": { "default": 1, "anyOf": [ { "type": "number", "minimum": 0, "exclusiveMinimum": true }, { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } ] }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "unitPriceInclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "vatClassifierCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "recognition": { "type": "object", "properties": { "method": { "default": "point_in_time", "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "startDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "milestones": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "expectedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "percent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "description", "percent" ] } } } }, "standaloneSellingPrice": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "refundEstimatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } } } } }, "required": [ "partnerId", "lines" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note", "proforma", "advance" ] }, "status": { "type": "string", "enum": [ "draft", "issued" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "appliedToInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "agreementId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatScheme": { "nullable": true, "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "recognitionMethod": { "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "recognitionStartDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionEndDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionMilestones": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expectedDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "percent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "description", "expectedDate", "percent" ], "additionalProperties": false } }, "standaloneSellingPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "allocatedNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "refundEstimatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "lineNet", "lineVat", "lineGross", "sortOrder", "recognitionMethod", "recognitionStartDate", "recognitionEndDate", "recognitionMilestones", "standaloneSellingPrice", "allocatedNet", "refundEstimatePercent" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "series", "number", "fullNumber", "issueDate", "dueDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "appliedToInvoiceId", "creditedInvoiceId", "agreementId", "vatScheme", "vatCountryCode", "deemedSupplier", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/get": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note", "proforma", "advance" ] }, "status": { "type": "string", "enum": [ "draft", "issued" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "appliedToInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "agreementId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatScheme": { "nullable": true, "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "recognitionMethod": { "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "recognitionStartDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionEndDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionMilestones": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expectedDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "percent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "description", "expectedDate", "percent" ], "additionalProperties": false } }, "standaloneSellingPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "allocatedNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "refundEstimatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "lineNet", "lineVat", "lineGross", "sortOrder", "recognitionMethod", "recognitionStartDate", "recognitionEndDate", "recognitionMilestones", "standaloneSellingPrice", "allocatedNet", "refundEstimatePercent" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "series", "number", "fullNumber", "issueDate", "dueDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "appliedToInvoiceId", "creditedInvoiceId", "agreementId", "vatScheme", "vatCountryCode", "deemedSupplier", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/pdf": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "locale": { "default": "lt", "type": "string", "enum": [ "lt", "en", "ru" ] } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "contentType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "data": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fileName", "contentType", "data" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/send": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "to": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "locale": { "default": "lt", "type": "string", "enum": [ "lt", "en", "ru" ] } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent": { "type": "boolean" }, "to": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "sent", "to" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/peppol-xml": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "contentType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "data": { "type": "string", "pattern": "^[\\s\\S]*$" }, "senderId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "receiverId": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fileName", "contentType", "data", "senderId", "receiverId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/peppol-send": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent": { "type": "boolean" }, "messageId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "receiverId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "sent", "messageId", "receiverId", "fileId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/update": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "issueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "vatScheme": { "nullable": true, "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "lines": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "quantity": { "default": 1, "anyOf": [ { "type": "number", "minimum": 0, "exclusiveMinimum": true }, { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } ] }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "unitPriceInclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "vatClassifierCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "recognition": { "type": "object", "properties": { "method": { "default": "point_in_time", "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "startDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "milestones": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "expectedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "percent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "description", "percent" ] } } } }, "standaloneSellingPrice": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "refundEstimatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } } } } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note", "proforma", "advance" ] }, "status": { "type": "string", "enum": [ "draft", "issued" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "appliedToInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "agreementId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatScheme": { "nullable": true, "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "recognitionMethod": { "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "recognitionStartDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionEndDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionMilestones": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expectedDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "percent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "description", "expectedDate", "percent" ], "additionalProperties": false } }, "standaloneSellingPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "allocatedNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "refundEstimatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "lineNet", "lineVat", "lineGross", "sortOrder", "recognitionMethod", "recognitionStartDate", "recognitionEndDate", "recognitionMilestones", "standaloneSellingPrice", "allocatedNet", "refundEstimatePercent" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "series", "number", "fullNumber", "issueDate", "dueDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "appliedToInvoiceId", "creditedInvoiceId", "agreementId", "vatScheme", "vatCountryCode", "deemedSupplier", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/delete": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/issue": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "series": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "issueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note", "proforma", "advance" ] }, "status": { "type": "string", "enum": [ "draft", "issued" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "appliedToInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "agreementId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatScheme": { "nullable": true, "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "recognitionMethod": { "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "recognitionStartDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionEndDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionMilestones": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expectedDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "percent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "description", "expectedDate", "percent" ], "additionalProperties": false } }, "standaloneSellingPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "allocatedNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "refundEstimatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "lineNet", "lineVat", "lineGross", "sortOrder", "recognitionMethod", "recognitionStartDate", "recognitionEndDate", "recognitionMilestones", "standaloneSellingPrice", "allocatedNet", "refundEstimatePercent" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "series", "number", "fullNumber", "issueDate", "dueDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "appliedToInvoiceId", "creditedInvoiceId", "agreementId", "vatScheme", "vatCountryCode", "deemedSupplier", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/recognition-schedules/list": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceLineId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "method": { "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "status": { "type": "string", "enum": [ "pending", "recognized", "cancelled" ] }, "scheduleDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "recognizedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "invoiceId", "invoiceLineId", "method", "status", "scheduleDate", "description", "amount", "journalTransactionId", "recognizedAt", "sortOrder", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/apply-advance": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "advanceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "advanceId", "invoiceId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note", "proforma", "advance" ] }, "status": { "type": "string", "enum": [ "draft", "issued" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "appliedToInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "agreementId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatScheme": { "nullable": true, "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "recognitionMethod": { "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "recognitionStartDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionEndDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "recognitionMilestones": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expectedDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "percent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "description", "expectedDate", "percent" ], "additionalProperties": false } }, "standaloneSellingPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "allocatedNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "refundEstimatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "lineNet", "lineVat", "lineGross", "sortOrder", "recognitionMethod", "recognitionStartDate", "recognitionEndDate", "recognitionMilestones", "standaloneSellingPrice", "allocatedNet", "refundEstimatePercent" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "series", "number", "fullNumber", "issueDate", "dueDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "appliedToInvoiceId", "creditedInvoiceId", "agreementId", "vatScheme", "vatCountryCode", "deemedSupplier", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/invoices/list": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note", "proforma", "advance" ] }, "status": { "type": "string", "enum": [ "draft", "issued" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "appliedToInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "agreementId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatScheme": { "nullable": true, "type": "string", "enum": [ "domestic", "intra_eu_b2b", "reverse_charge", "oss_union", "ioss", "marketplace_deemed", "export", "out_of_scope", "sme_exempt" ] }, "vatCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "deemedSupplier": { "type": "boolean" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "series", "number", "fullNumber", "issueDate", "dueDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "appliedToInvoiceId", "creditedInvoiceId", "agreementId", "vatScheme", "vatCountryCode", "deemedSupplier", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/acts/create": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "default": "goods", "type": "string", "enum": [ "goods", "services" ] }, "documentDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "saleInvoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "series": { "default": "PPA", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "lines": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,9}(\\.\\d{1,3})?$" }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } }, "required": [ "quantity" ] } } }, "required": [ "partnerId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "goods", "services" ] }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "lineNet", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "series", "fullNumber", "documentDate", "saleInvoiceId", "transferredByName", "transferredByTitle", "acceptedByName", "acceptedByTitle", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/acts/update": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "goods", "services" ] }, "documentDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "saleInvoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "series": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "lines": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,9}(\\.\\d{1,3})?$" }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } }, "required": [ "quantity" ] } }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "goods", "services" ] }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "lineNet", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "series", "fullNumber", "documentDate", "saleInvoiceId", "transferredByName", "transferredByTitle", "acceptedByName", "acceptedByTitle", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/acts/issue": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "goods", "services" ] }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "lineNet", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "series", "fullNumber", "documentDate", "saleInvoiceId", "transferredByName", "transferredByTitle", "acceptedByName", "acceptedByTitle", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/acts/cancel": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "goods", "services" ] }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "type", "status", "series", "fullNumber", "documentDate", "saleInvoiceId", "transferredByName", "transferredByTitle", "acceptedByName", "acceptedByTitle", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/acts/get": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "goods", "services" ] }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "lineNet", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "series", "fullNumber", "documentDate", "saleInvoiceId", "transferredByName", "transferredByTitle", "acceptedByName", "acceptedByTitle", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/acts/list": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "goods", "services" ] }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transferredByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transferredByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "acceptedByTitle": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "type", "status", "series", "fullNumber", "documentDate", "saleInvoiceId", "transferredByName", "transferredByTitle", "acceptedByName", "acceptedByTitle", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/acts/pdf": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "locale": { "default": "lt", "type": "string", "enum": [ "lt", "en", "ru" ] } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "contentType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "data": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fileName", "contentType", "data" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/recognition/compute": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asOfDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "asOfDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "scheduleId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceFullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "invoiceLineId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineDescription": { "type": "string", "pattern": "^[\\s\\S]*$" }, "scheduleDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "scheduleId", "invoiceId", "invoiceFullNumber", "invoiceLineId", "lineDescription", "scheduleDate", "description", "amount" ], "additionalProperties": false } } }, "required": [ "asOfDate", "totalAmount", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/recognition/run": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asOfDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "postingDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "scheduleIds": { "minItems": 1, "maxItems": 500, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "runId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "runDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "trigger": { "type": "string", "enum": [ "manual", "schedule_due", "period_close", "delivery_act", "progress", "modification" ] }, "scheduleCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "runId", "runDate", "trigger", "scheduleCount", "totalAmount", "journalTransactionId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/recognition/progress": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceLineId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "percentComplete": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "invoiceLineId", "percentComplete" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "runId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "runDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "scheduleCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "runId", "runDate", "scheduleCount", "totalAmount", "journalTransactionId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/recognition/modify": { "post": { "tags": [ "sales" ], "description": "Apply an IFRS 15 contract modification to a deferred invoice line. Prospective: cancel the pending schedule and respread the unrecognized remainder over the new terms. Cumulative catch-up (ratable only): recompute revenue as if the new terms applied from the start and post the difference immediately.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceLineId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "approach": { "type": "string", "enum": [ "prospective", "cumulative_catch_up" ] }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "newEndDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "newMilestones": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "expectedDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "percent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "description", "percent" ] } } }, "required": [ "invoiceLineId", "approach" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceLineId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "approach": { "type": "string", "enum": [ "prospective", "cumulative_catch_up" ] }, "cancelledCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "newPendingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "catchUpAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "newEndDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "invoiceLineId", "approach", "cancelledCount", "newPendingCount", "catchUpAmount", "journalTransactionId", "newEndDate" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/recognition/runs/list": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "runDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "trigger": { "type": "string", "enum": [ "manual", "schedule_due", "period_close", "delivery_act", "progress", "modification" ] }, "scheduleCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "runDate", "trigger", "scheduleCount", "totalAmount", "journalTransactionId", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/recognition/summary": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceFullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "invoiceLineId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineDescription": { "type": "string", "pattern": "^[\\s\\S]*$" }, "method": { "type": "string", "enum": [ "point_in_time", "ratable", "milestone", "percent_complete" ] }, "deferredTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "recognizedToDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remaining": { "type": "string", "pattern": "^[\\s\\S]*$" }, "pendingCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "nextScheduleDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "invoiceId", "invoiceFullNumber", "invoiceLineId", "lineDescription", "method", "deferredTotal", "recognizedToDate", "remaining", "pendingCount", "nextScheduleDate" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "deferredTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "recognizedToDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remaining": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "deferredTotal", "recognizedToDate", "remaining" ], "additionalProperties": false } }, "required": [ "rows", "totals" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/refund-liability/list": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceFullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "estimated": { "type": "string", "pattern": "^[\\s\\S]*$" }, "consumed": { "type": "string", "pattern": "^[\\s\\S]*$" }, "settlementRefunds": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remaining": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "invoiceId", "invoiceFullNumber", "estimated", "consumed", "settlementRefunds", "remaining", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/sales/refund-liability/true-up": { "post": { "tags": [ "sales" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "estimatedTotal": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "invoiceId", "estimatedTotal" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "estimated": { "type": "string", "pattern": "^[\\s\\S]*$" }, "consumed": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remaining": { "type": "string", "pattern": "^[\\s\\S]*$" }, "delta": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "invoiceId", "estimated", "consumed", "remaining", "delta", "journalTransactionId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/purchases/invoices/create": { "post": { "tags": [ "purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "default": "invoice", "type": "string", "enum": [ "invoice", "credit_note" ] }, "documentNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "lines": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "quantity": { "default": 1, "anyOf": [ { "type": "number", "minimum": 0, "exclusiveMinimum": true }, { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } ] }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "unitPriceInclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "vatClassifierCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } } } } }, "required": [ "partnerId", "documentNumber", "documentDate", "lines" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note" ] }, "status": { "type": "string", "enum": [ "draft", "registered" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "documentNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "accountCode", "lineNet", "lineVat", "lineGross", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "documentNumber", "documentDate", "dueDate", "registrationDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "creditedInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/purchases/invoices/get": { "post": { "tags": [ "purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note" ] }, "status": { "type": "string", "enum": [ "draft", "registered" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "documentNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "accountCode", "lineNet", "lineVat", "lineGross", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "documentNumber", "documentDate", "dueDate", "registrationDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "creditedInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/purchases/invoices/update": { "post": { "tags": [ "purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "documentNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dueDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "lines": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "quantity": { "default": 1, "anyOf": [ { "type": "number", "minimum": 0, "exclusiveMinimum": true }, { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } ] }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "unitPriceInclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "vatClassifierCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } } } } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note" ] }, "status": { "type": "string", "enum": [ "draft", "registered" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "documentNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "accountCode", "lineNet", "lineVat", "lineGross", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "documentNumber", "documentDate", "dueDate", "registrationDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "creditedInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/purchases/invoices/delete": { "post": { "tags": [ "purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/purchases/invoices/register": { "post": { "tags": [ "purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "registrationDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note" ] }, "status": { "type": "string", "enum": [ "draft", "registered" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "documentNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceInclVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatClassifierCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lineNet": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lineGross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "unitPriceExclVat", "unitPriceInclVat", "vatRatePercent", "vatClassifierCode", "costCenterId", "accountCode", "lineNet", "lineVat", "lineGross", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "documentNumber", "documentDate", "dueDate", "registrationDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "creditedInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/purchases/invoices/list": { "post": { "tags": [ "purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "invoice", "credit_note" ] }, "status": { "type": "string", "enum": [ "draft", "registered" ] }, "paymentStatus": { "type": "string", "enum": [ "unpaid", "partial", "paid" ] }, "documentNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dueDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "paidAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "creditedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "partnerId", "type", "status", "paymentStatus", "documentNumber", "documentDate", "dueDate", "registrationDate", "currency", "netTotal", "vatTotal", "grossTotal", "paidAmount", "journalTransactionId", "creditedInvoiceId", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/intrastat/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2016, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "flow": { "type": "string", "enum": [ "arrivals", "dispatches" ] }, "transactionNature": { "default": "11", "type": "string", "pattern": "^\\d{2}$" }, "deliveryTerms": { "type": "string", "pattern": "^[A-Z]{3}$" }, "transportMode": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "7", "8", "9" ] }, "persist": { "default": false, "type": "boolean" } }, "required": [ "year", "month", "flow" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "flow": { "type": "string", "enum": [ "arrivals", "dispatches" ] }, "referencePeriod": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodStart": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodEnd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "itemNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "cnCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transactionNature": { "type": "string", "pattern": "^[\\s\\S]*$" }, "deliveryTerms": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transportMode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "country": { "type": "string", "pattern": "^[\\s\\S]*$" }, "originCountry": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerVat": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "netMassKg": { "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryUnit": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "supplementaryQty": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "invoicedValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "statisticalValue": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemNumber", "cnCode", "description", "transactionNature", "deliveryTerms", "transportMode", "country", "originCountry", "partnerVat", "netMassKg", "supplementaryUnit", "supplementaryQty", "invoicedValue", "statisticalValue" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "invoicedValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "statisticalValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netMassKg": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "invoicedValue", "statisticalValue", "netMassKg", "lines" ], "additionalProperties": false }, "counts": { "type": "object", "properties": { "invoices": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "linesIncluded": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "linesSkipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "invoices", "linesIncluded", "linesSkipped" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "xml": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "flow", "referencePeriod", "periodStart", "periodEnd", "fileName", "fileId", "rows", "totals", "counts", "warnings", "notes", "xml" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/ivaz/generate": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "waybillIds": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "persist": { "default": false, "type": "boolean" } }, "required": [ "waybillIds" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "counts": { "type": "object", "properties": { "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "documents" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "xml": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fileName", "fileId", "counts", "warnings", "notes", "xml" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/intrastat/obligation": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2016, "maximum": 2100, "format": "int64" } }, "required": [ "year" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "isVatPayer": { "type": "boolean" }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "thresholds": { "type": "object", "properties": { "arrivalsReporting": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchesReporting": { "type": "string", "pattern": "^[\\s\\S]*$" }, "arrivalsStatistical": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchesStatistical": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "arrivalsReporting", "dispatchesReporting", "arrivalsStatistical", "dispatchesStatistical" ], "additionalProperties": false }, "arrivals": { "type": "object", "properties": { "previousYearValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "obligatedFromMonth": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "statisticalValueRequired": { "type": "boolean" }, "monthly": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "value": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cumulative": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "month", "value", "cumulative" ], "additionalProperties": false } } }, "required": [ "previousYearValue", "obligatedFromMonth", "statisticalValueRequired", "monthly" ], "additionalProperties": false }, "dispatches": { "type": "object", "properties": { "previousYearValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "obligatedFromMonth": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "statisticalValueRequired": { "type": "boolean" }, "monthly": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "value": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cumulative": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "month", "value", "cumulative" ], "additionalProperties": false } } }, "required": [ "previousYearValue", "obligatedFromMonth", "statisticalValueRequired", "monthly" ], "additionalProperties": false } }, "required": [ "year", "isVatPayer", "notes", "thresholds", "arrivals", "dispatches" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/isaf/generate": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2016, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "dataType": { "default": "F", "type": "string", "enum": [ "F", "S", "P" ] } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodStart": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodEnd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counts": { "type": "object", "properties": { "salesInvoices": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "purchaseInvoices": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "customers": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "suppliers": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "salesInvoices", "purchaseInvoices", "customers", "suppliers" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "xml": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fileName", "periodStart", "periodEnd", "counts", "warnings", "xml" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/fr0600/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2016, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "months": { "default": 1, "type": "integer", "minimum": 1, "maximum": 6, "format": "int64" }, "deductionPercent": { "default": 100, "type": "integer", "minimum": 0, "maximum": 100, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "periodStart": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodEnd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "deductionPercent": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "pattern": "^[\\s\\S]*$" }, "label": { "type": "string", "pattern": "^[\\s\\S]*$" }, "value": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "field", "label", "value" ], "additionalProperties": false } }, "breakdown": { "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "sales", "purchases" ] }, "taxCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "taxableFields": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "vatFields": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "direction", "taxCode", "net", "vat", "taxableFields", "vatFields" ], "additionalProperties": false } }, "counts": { "type": "object", "properties": { "salesInvoices": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "purchaseInvoices": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "salesInvoices", "purchaseInvoices" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "periodStart", "periodEnd", "deductionPercent", "fields", "breakdown", "counts", "warnings", "notes" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/gpm313/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2018, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "payoutTiming": { "default": "next-month", "type": "string", "enum": [ "same-month", "next-month" ] }, "paymentDay": { "default": 10, "type": "integer", "minimum": 1, "maximum": 31, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "declarationYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "declarationMonth": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "runPeriod": { "nullable": true, "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "year", "month" ], "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "pattern": "^[\\s\\S]*$" }, "label": { "type": "string", "pattern": "^[\\s\\S]*$" }, "value": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "field", "label", "value" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "declarationYear", "declarationMonth", "runPeriod", "fields", "warnings", "notes" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/sam/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2018, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "insuredCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "insuredIncomeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "contributionsTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "persons": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "personalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "insuredIncome": { "type": "string", "pattern": "^[\\s\\S]*$" }, "contributions": { "type": "string", "pattern": "^[\\s\\S]*$" }, "tariffPercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "personalCode", "socialInsuranceNo", "firstName", "lastName", "insuredIncome", "contributions", "tariffPercent" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "year", "month", "insuredCount", "insuredIncomeTotal", "contributionsTotal", "persons", "warnings", "notes" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/sd/generate": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "1-SD", "2-SD" ] }, "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "type", "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "1-SD", "2-SD" ] }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractNo": { "type": "string", "pattern": "^[\\s\\S]*$" }, "personalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "professionCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "endReason": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "finalInsuredIncome": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "finalContributions": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "contractId", "contractNo", "personalCode", "socialInsuranceNo", "firstName", "lastName", "date", "professionCode", "endReason", "finalInsuredIncome", "finalContributions" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "type", "fromDate", "toDate", "rows", "warnings", "notes" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/lt/saft/generate": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dataType": { "default": "F", "type": "string", "enum": [ "F", "GL", "SI", "PI", "PA", "MG", "AS" ] }, "persist": { "default": false, "type": "boolean" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "periodStart": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodEnd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counts": { "type": "object", "properties": { "accounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "customers": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "suppliers": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "glTransactions": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "salesInvoices": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "purchaseInvoices": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "payments": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "stockMovements": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "assetTransactions": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "accounts", "customers", "suppliers", "glTransactions", "salesInvoices", "purchaseInvoices", "payments", "stockMovements", "assetTransactions" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "xml": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fileName", "fileId", "periodStart", "periodEnd", "counts", "warnings", "xml" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/oss/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2021, "maximum": 2100, "format": "int64" }, "quarter": { "type": "integer", "minimum": 1, "maximum": 4, "format": "int64" } }, "required": [ "year", "quarter" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "periodYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "memberStateOfIdentification": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rateType": { "type": "string", "enum": [ "STANDARD", "REDUCED" ] }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "countryCode", "rateType", "vatRatePercent", "taxableAmount", "vatAmount", "documents" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "taxableAmount", "vatAmount" ], "additionalProperties": false }, "corrections": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "periodQuarter": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "periodMonth": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "countryCode", "periodYear", "periodQuarter", "periodMonth", "taxableAmount", "vatAmount", "documents" ], "additionalProperties": false } }, "correctionsTotal": { "type": "object", "properties": { "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "taxableAmount", "vatAmount" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "periodQuarter": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "periodYear", "fromDate", "toDate", "memberStateOfIdentification", "rows", "totals", "corrections", "correctionsTotal", "warnings", "periodQuarter" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/ioss/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2021, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "periodYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "memberStateOfIdentification": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rateType": { "type": "string", "enum": [ "STANDARD", "REDUCED" ] }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "countryCode", "rateType", "vatRatePercent", "taxableAmount", "vatAmount", "documents" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "taxableAmount", "vatAmount" ], "additionalProperties": false }, "corrections": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "periodQuarter": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "periodMonth": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "countryCode", "periodYear", "periodQuarter", "periodMonth", "taxableAmount", "vatAmount", "documents" ], "additionalProperties": false } }, "correctionsTotal": { "type": "object", "properties": { "taxableAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "taxableAmount", "vatAmount" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "periodMonth": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "periodYear", "fromDate", "toDate", "memberStateOfIdentification", "rows", "totals", "corrections", "correctionsTotal", "warnings", "periodMonth" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/distance-sales-threshold/get": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "thresholdEur": { "type": "string", "pattern": "^[\\s\\S]*$" }, "homeCountryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currentYear": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "year", "totalAmount", "documents" ], "additionalProperties": false }, "precedingYear": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "year", "totalAmount", "documents" ], "additionalProperties": false }, "belowThreshold": { "type": "boolean" }, "headroomAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "thresholdEur", "homeCountryCode", "currentYear", "precedingYear", "belowThreshold", "headroomAmount", "warnings" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/union-turnover/get": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capEur": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isVatPayer": { "type": "boolean" }, "currentYear": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "year", "amount", "documents" ], "additionalProperties": false }, "previousYear": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "year", "amount", "documents" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "below", "approaching", "exceeded", "not_applicable" ] }, "headroomAmount": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "capEur", "currency", "isVatPayer", "currentYear", "previousYear", "status", "headroomAmount", "warnings" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/sme-cross-border-report/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2025, "maximum": 2100, "format": "int64" }, "quarter": { "type": "integer", "minimum": 1, "maximum": 4, "format": "int64" } }, "required": [ "year", "quarter" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "quarter": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "countryCode", "amount", "documents" ], "additionalProperties": false } }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "year", "quarter", "fromDate", "toDate", "currency", "rows", "total", "warnings" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/sme-thresholds/list": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nationalCapEur": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unionTurnoverCapEur": { "type": "string", "pattern": "^[\\s\\S]*$" }, "thresholds": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "nationalThreshold": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sectors": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "note": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "label", "amount" ], "additionalProperties": false } }, "intraEuAcquisitionsTrigger": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "note": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "amount", "currency", "note" ], "additionalProperties": false }, "note": { "type": "string", "pattern": "^[\\s\\S]*$" }, "source": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "countryCode", "currency", "nationalThreshold", "source" ], "additionalProperties": false } } }, "required": [ "nationalCapEur", "unionTurnoverCapEur", "thresholds" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/sme-threshold/get": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isVatPayer": { "type": "boolean" }, "baseCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "threshold": { "nullable": true, "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "nationalThreshold": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sectors": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "note": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "label", "amount" ], "additionalProperties": false } }, "note": { "type": "string", "pattern": "^[\\s\\S]*$" }, "source": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "currency", "nationalThreshold", "source" ], "additionalProperties": false }, "turnover": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "amount", "currency", "documents" ], "additionalProperties": false }, "precedingTurnover": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "year", "amount", "documents" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "not_applicable", "below", "approaching", "exceeded", "unknown" ] }, "headroomAmount": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "intraEu": { "nullable": true, "type": "object", "properties": { "trigger": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionsFromMemberStates": { "type": "string", "pattern": "^[\\s\\S]*$" }, "servicesToMemberStates": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "below", "approaching", "exceeded" ] }, "note": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "trigger", "currency", "acquisitionsFromMemberStates", "servicesToMemberStates", "total", "status", "note" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "countryCode", "isVatPayer", "baseCurrency", "year", "threshold", "turnover", "precedingTurnover", "status", "headroomAmount", "intraEu", "warnings" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/vat-return/packs/list": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "packs": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "formKey": { "type": "string", "pattern": "^[\\s\\S]*$" }, "formName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "frequency": { "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "source": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "countryCode", "formKey", "formName", "frequency", "source" ], "additionalProperties": false } } }, "required": [ "packs" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/eu/vat-return/compute": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": 2016, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "months": { "default": 1, "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "countryCode", "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "formKey": { "type": "string", "pattern": "^[\\s\\S]*$" }, "formName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "frequency": { "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "periodStart": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodEnd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "boxes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "label": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "label", "amount" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "notes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "source": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "countryCode", "formKey", "formName", "frequency", "periodStart", "periodEnd", "boxes", "warnings", "notes", "source" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/configs/list": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string", "pattern": "^[\\s\\S]*$" }, "country": { "type": "string", "pattern": "^[\\s\\S]*$" }, "title": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[\\s\\S]*$" }, "kind": { "type": "string", "enum": [ "text", "secret", "select" ] }, "multiline": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "key", "kind" ], "additionalProperties": false } }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "test": { "type": "string", "pattern": "^[\\s\\S]*$" }, "production": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false } }, "values": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 } }, "required": [ "system", "country", "title", "fields", "values" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/configs/update": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "system": { "type": "string", "minLength": 1, "maxLength": 40, "pattern": "^[\\s\\S]*$" }, "config": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 20000, "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 } }, "required": [ "system", "config" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "system": { "type": "string", "pattern": "^[\\s\\S]*$" }, "country": { "type": "string", "pattern": "^[\\s\\S]*$" }, "title": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[\\s\\S]*$" }, "kind": { "type": "string", "enum": [ "text", "secret", "select" ] }, "multiline": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "key", "kind" ], "additionalProperties": false } }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "test": { "type": "string", "pattern": "^[\\s\\S]*$" }, "production": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false } }, "values": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 } }, "required": [ "system", "country", "title", "fields", "values" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/submissions/create": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "obligation": { "type": "string", "enum": [ "lt-isaf" ] }, "year": { "type": "integer", "minimum": 2016, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "dataType": { "default": "F", "type": "string", "enum": [ "F", "S", "P" ] } }, "required": [ "obligation", "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "obligation": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "periodMonth": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "variant": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "generated", "submitted", "accepted", "rejected" ] }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "message": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "id", "obligation", "periodYear", "periodMonth", "variant", "status", "fileName", "fileId", "externalRef", "message", "createdAt", "updatedAt", "warnings" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/submissions/mark": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "submitted", "accepted", "rejected" ] }, "externalRef": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "message": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "status" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "obligation": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "periodMonth": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "variant": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "generated", "submitted", "accepted", "rejected" ] }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "message": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "obligation", "periodYear", "periodMonth", "variant", "status", "fileName", "fileId", "externalRef", "message", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/declarations/submissions/list": { "post": { "tags": [ "declarations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "obligation": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodYear": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "periodMonth": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "variant": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "generated", "submitted", "accepted", "rejected" ] }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "message": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "obligation", "periodYear", "periodMonth", "variant", "status", "fileName", "fileId", "externalRef", "message", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/accounts/list": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "asset", "liability", "equity", "income", "expense" ] }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "isPostable": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "type", "parentId", "isPostable", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/accounts/create": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "asset", "liability", "equity", "income", "expense" ] }, "parentId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "isPostable": { "default": true, "type": "boolean" } }, "required": [ "code", "name", "type" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "asset", "liability", "equity", "income", "expense" ] }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "isPostable": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "type", "parentId", "isPostable", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/accounts/update": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "isPostable": { "type": "boolean" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "asset", "liability", "equity", "income", "expense" ] }, "parentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "isPostable": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "type", "parentId", "isPostable", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/accounts/apply-template": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "accounts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "accounts" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/periods/list": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "open", "locked" ] } }, "required": [ "id", "year", "month", "status" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/periods/lock": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "open", "locked" ] } }, "required": [ "id", "year", "month", "status" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/periods/unlock": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "open", "locked" ] } }, "required": [ "id", "year", "month", "status" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/journal/transactions/list": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "posted" ] }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "postedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "date", "description", "documentType", "documentId", "status", "createdAt", "postedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/cost-centers/create": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "groupId", "groupName", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/cost-centers/update": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "groupId", "groupName", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/cost-centers/list": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "groupId", "groupName", "isActive", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/cost-center-groups/create": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/cost-center-groups/update": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/cost-center-groups/delete": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/cost-center-groups/list": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/posting-rules/list": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "defaultCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "overridden": { "type": "boolean" } }, "required": [ "key", "description", "defaultCode", "accountCode", "overridden" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/posting-rules/update": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rules": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "sales.receivable", "sales.revenueProducts", "sales.revenueServices", "sales.vatPayable", "sales.advancesReceived", "purchases.payables", "purchases.vatReceivable", "purchases.goodsForResale", "purchases.defaultExpense", "inventory.cogs", "inventory.stock", "bank.fxGain", "bank.fxLoss", "settlements.fees", "settlements.commissionRevenue", "settlements.sellerPayable", "settlements.suspense", "revenue.deferredIncome", "revenue.contractAsset", "revenue.refundLiability" ] }, "accountCode": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } }, "required": [ "key", "accountCode" ] } } }, "required": [ "rules" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "defaultCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "overridden": { "type": "boolean" } }, "required": [ "key", "description", "defaultCode", "accountCode", "overridden" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/owners/create": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 35, "pattern": "^[\\s\\S]*$" }, "equityAccountCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "sharesQuantity": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "sharesAmount": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "sharesType": { "type": "string", "enum": [ "V", "PR", "PP", "PRV" ] }, "sharesAcquisitionDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "equityAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesQuantity": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesAmount": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesAcquisitionDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "code", "equityAccountCode", "sharesQuantity", "sharesAmount", "sharesType", "sharesAcquisitionDate", "address", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/owners/update": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 35, "pattern": "^[\\s\\S]*$" }, "equityAccountCode": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "sharesQuantity": { "nullable": true, "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "sharesAmount": { "nullable": true, "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "sharesType": { "nullable": true, "type": "string", "enum": [ "V", "PR", "PP", "PRV" ] }, "sharesAcquisitionDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "equityAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesQuantity": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesAmount": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesAcquisitionDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "code", "equityAccountCode", "sharesQuantity", "sharesAmount", "sharesType", "sharesAcquisitionDate", "address", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/owners/delete": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "deleted": { "type": "boolean", "enum": [ true ] } }, "required": [ "id", "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/owners/list": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "equityAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesQuantity": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesAmount": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sharesAcquisitionDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "code", "equityAccountCode", "sharesQuantity", "sharesAmount", "sharesType", "sharesAcquisitionDate", "address", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/journal/transactions/get": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "posted" ] }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "postedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "debit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "credit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "accountId", "accountCode", "accountName", "costCenterId", "debit", "credit", "description" ], "additionalProperties": false } } }, "required": [ "id", "date", "description", "documentType", "documentId", "status", "createdAt", "postedAt", "entries" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ledger/journal/transactions/create": { "post": { "tags": [ "ledger" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "description": { "type": "string", "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "entries": { "minItems": 2, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "accountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "debit": { "default": "0", "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "credit": { "default": "0", "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "description": { "type": "string", "maxLength": 500, "pattern": "^[\\s\\S]*$" } }, "required": [ "accountCode" ] } } }, "required": [ "date", "entries" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "posted" ] }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "postedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "date", "description", "documentType", "documentId", "status", "createdAt", "postedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/groups/create": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "defaultUsefulLifeMonths": { "type": "integer", "minimum": 1, "maximum": 1200, "format": "int64" }, "assetAccountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "depreciationAccountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "expenseAccountCode": { "default": "6206", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "assetAccountCode", "depreciationAccountCode" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "defaultUsefulLifeMonths": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "assetAccountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "depreciationAccountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "expenseAccountCode": { "default": "6206", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "defaultUsefulLifeMonths", "assetAccountCode", "depreciationAccountCode", "expenseAccountCode", "id", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/groups/list": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "defaultUsefulLifeMonths": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "assetAccountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "depreciationAccountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "expenseAccountCode": { "default": "6206", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "defaultUsefulLifeMonths", "assetAccountCode", "depreciationAccountCode", "expenseAccountCode", "id", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/assets/create": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "acquisitionDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "depreciationStartDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "acquisitionCost": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "salvageValue": { "default": "0", "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "usefulLifeMonths": { "type": "integer", "minimum": 1, "maximum": 1200, "format": "int64" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "groupId", "code", "name", "acquisitionDate", "acquisitionCost" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciationStartDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "salvageValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "usefulLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accumulatedDepreciation": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netBookValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciatedMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "active", "fully_depreciated", "disposed" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "groupId", "code", "name", "acquisitionDate", "depreciationStartDate", "acquisitionCost", "salvageValue", "usefulLifeMonths", "totalCost", "accumulatedDepreciation", "netBookValue", "depreciatedMonths", "totalLifeMonths", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/assets/get": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciationStartDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "salvageValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "usefulLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accumulatedDepreciation": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netBookValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciatedMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "active", "fully_depreciated", "disposed" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "groupId", "code", "name", "acquisitionDate", "depreciationStartDate", "acquisitionCost", "salvageValue", "usefulLifeMonths", "totalCost", "accumulatedDepreciation", "netBookValue", "depreciatedMonths", "totalLifeMonths", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/assets/list": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciationStartDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "salvageValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "usefulLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accumulatedDepreciation": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netBookValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciatedMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "active", "fully_depreciated", "disposed" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "groupId", "code", "name", "acquisitionDate", "depreciationStartDate", "acquisitionCost", "salvageValue", "usefulLifeMonths", "totalCost", "accumulatedDepreciation", "netBookValue", "depreciatedMonths", "totalLifeMonths", "status", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/assets/modernize": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "amount": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "addedLifeMonths": { "default": 0, "type": "integer", "minimum": 0, "maximum": 1200, "format": "int64" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "date", "amount" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciationStartDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "acquisitionCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "salvageValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "usefulLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accumulatedDepreciation": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netBookValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "depreciatedMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "totalLifeMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "active", "fully_depreciated", "disposed" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "groupId", "code", "name", "acquisitionDate", "depreciationStartDate", "acquisitionCost", "salvageValue", "usefulLifeMonths", "totalCost", "accumulatedDepreciation", "netBookValue", "depreciatedMonths", "totalLifeMonths", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/depreciation/preview": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "alreadyPosted": { "type": "boolean" } }, "required": [ "assetId", "code", "name", "amount", "alreadyPosted" ], "additionalProperties": false } }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "rows", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/depreciation/post": { "post": { "tags": [ "assets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "posted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "posted", "skipped", "total", "journalTransactionId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/positions/create": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "translations": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] }, "maxProperties": 100 } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 } }, "required": [ "id", "code", "name", "translations" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/positions/update": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] }, "maxProperties": 100 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 } }, "required": [ "id", "code", "name", "translations" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/positions/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 } }, "required": [ "id", "code", "name", "translations" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/create": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "personalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "birthDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } }, "iban": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "type": "string", "maxLength": 30, "pattern": "^[\\s\\S]*$" }, "socialInsuranceStart": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "hireDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "applyNpd": { "type": "boolean" }, "npdOverride": { "nullable": true, "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" }, "pensionAccumulation": { "type": "boolean" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "firstName", "lastName" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "personalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceStart": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "hireDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "terminationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "applyNpd": { "type": "boolean" }, "npdOverride": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "pensionAccumulation": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "firstName", "lastName", "personalCode", "birthDate", "email", "phone", "address", "iban", "socialInsuranceNo", "socialInsuranceStart", "hireDate", "terminationDate", "applyNpd", "npdOverride", "pensionAccumulation", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/update": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "personalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "birthDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } }, "iban": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "type": "string", "maxLength": 30, "pattern": "^[\\s\\S]*$" }, "socialInsuranceStart": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "hireDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "applyNpd": { "type": "boolean" }, "npdOverride": { "nullable": true, "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" }, "pensionAccumulation": { "type": "boolean" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "terminationDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "status": { "type": "string", "enum": [ "active", "terminated" ] } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "personalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceStart": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "hireDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "terminationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "applyNpd": { "type": "boolean" }, "npdOverride": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "pensionAccumulation": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "firstName", "lastName", "personalCode", "birthDate", "email", "phone", "address", "iban", "socialInsuranceNo", "socialInsuranceStart", "hireDate", "terminationDate", "applyNpd", "npdOverride", "pensionAccumulation", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/get": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "personalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceStart": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "hireDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "terminationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "applyNpd": { "type": "boolean" }, "npdOverride": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "pensionAccumulation": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "firstName", "lastName", "personalCode", "birthDate", "email", "phone", "address", "iban", "socialInsuranceNo", "socialInsuranceStart", "hireDate", "terminationDate", "applyNpd", "npdOverride", "pensionAccumulation", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "personalCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "birthDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceNo": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "socialInsuranceStart": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "hireDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "terminationDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "applyNpd": { "type": "boolean" }, "npdOverride": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "pensionAccumulation": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "firstName", "lastName", "personalCode", "birthDate", "email", "phone", "address", "iban", "socialInsuranceNo", "socialInsuranceStart", "hireDate", "terminationDate", "applyNpd", "npdOverride", "pensionAccumulation", "status", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/contracts/create": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "positionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "departmentId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "scheduleId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractNo": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "type": { "default": "permanent", "type": "string", "enum": [ "permanent", "fixed_term" ] }, "startDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "baseSalary": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "salaryType": { "default": "monthly", "type": "string", "enum": [ "monthly", "hourly" ] }, "workHoursPerWeek": { "default": "40", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "contractNo", "startDate", "baseSalary" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "positionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "departmentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "scheduleId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractNo": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "permanent", "fixed_term" ] }, "startDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "endReason": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "baseSalary": { "type": "string", "pattern": "^[\\s\\S]*$" }, "salaryType": { "type": "string", "enum": [ "monthly", "hourly" ] }, "workHoursPerWeek": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "active", "ended" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "positionId", "departmentId", "scheduleId", "contractNo", "type", "startDate", "endDate", "endReason", "baseSalary", "salaryType", "workHoursPerWeek", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/contracts/end": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "endDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endReason": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "endDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "positionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "departmentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "scheduleId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractNo": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "permanent", "fixed_term" ] }, "startDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "endReason": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "baseSalary": { "type": "string", "pattern": "^[\\s\\S]*$" }, "salaryType": { "type": "string", "enum": [ "monthly", "hourly" ] }, "workHoursPerWeek": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "active", "ended" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "positionId", "departmentId", "scheduleId", "contractNo", "type", "startDate", "endDate", "endReason", "baseSalary", "salaryType", "workHoursPerWeek", "status", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/contracts/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "positionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "departmentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "scheduleId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractNo": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "permanent", "fixed_term" ] }, "startDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "endReason": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "baseSalary": { "type": "string", "pattern": "^[\\s\\S]*$" }, "salaryType": { "type": "string", "enum": [ "monthly", "hourly" ] }, "workHoursPerWeek": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "active", "ended" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "positionId", "departmentId", "scheduleId", "contractNo", "type", "startDate", "endDate", "endReason", "baseSalary", "salaryType", "workHoursPerWeek", "status", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/leave-balances/set": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "entitledDays": { "type": "string", "pattern": "^\\d{1,4}(\\.\\d{1,2})?$" }, "usedDays": { "type": "string", "pattern": "^\\d{1,4}(\\.\\d{1,2})?$" } }, "required": [ "employeeId", "year", "entitledDays" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "entitledDays": { "type": "string", "pattern": "^[\\s\\S]*$" }, "usedDays": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remainingDays": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "year", "entitledDays", "usedDays", "remainingDays" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/leave-balances/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "entitledDays": { "type": "string", "pattern": "^[\\s\\S]*$" }, "usedDays": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remainingDays": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "year", "entitledDays", "usedDays", "remainingDays" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/incapacity-certificates/create": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "series": { "type": "string", "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "minLength": 1, "maxLength": 30, "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "reason": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "number", "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "reason": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "series", "number", "fromDate", "toDate", "reason", "notes" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/incapacity-certificates/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "series": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "reason": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "series", "number", "fromDate", "toDate", "reason", "notes" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/records/create": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "education", "qualification", "certificate", "training" ] }, "title": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "institution": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "issuedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "validUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "fileId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "type", "title" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "education", "qualification", "certificate", "training" ] }, "title": { "type": "string", "pattern": "^[\\s\\S]*$" }, "institution": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issuedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "validUntil": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "type", "title", "institution", "issuedAt", "validUntil", "fileId", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/records/update": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "education", "qualification", "certificate", "training" ] }, "title": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "institution": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "issuedAt": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "validUntil": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "education", "qualification", "certificate", "training" ] }, "title": { "type": "string", "pattern": "^[\\s\\S]*$" }, "institution": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issuedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "validUntil": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "type", "title", "institution", "issuedAt", "validUntil", "fileId", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/records/delete": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/records/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "education", "qualification", "certificate", "training" ] }, "title": { "type": "string", "pattern": "^[\\s\\S]*$" }, "institution": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "issuedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "validUntil": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "type", "title", "institution", "issuedAt", "validUntil", "fileId", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/employees/attachments/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "mimeType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "fileName", "mimeType", "sizeBytes", "createdAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/timesheets/generate": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "generated" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/timesheets/upsert": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "days": { "maxItems": 31, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "integer", "minimum": 1, "maximum": 31, "format": "int64" }, "hours": { "type": "string", "pattern": "^\\d{1,2}(\\.\\d{1,2})?$" }, "type": { "type": "string", "enum": [ "work", "business_trip", "vacation", "sick", "holiday", "unpaid" ] } }, "required": [ "day", "hours", "type" ] } } }, "required": [ "employeeId", "year", "month", "days" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "days": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "integer", "minimum": 1, "maximum": 31, "format": "int64" }, "hours": { "type": "string", "pattern": "^\\d{1,2}(\\.\\d{1,2})?$" }, "type": { "type": "string", "enum": [ "work", "business_trip", "vacation", "sick", "holiday", "unpaid" ] } }, "required": [ "day", "hours", "type" ], "additionalProperties": false } }, "workedDays": { "type": "string", "pattern": "^[\\s\\S]*$" }, "workedHours": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "employeeName", "year", "month", "days", "workedDays", "workedHours", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/timesheets/get": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "employeeId", "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "days": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "integer", "minimum": 1, "maximum": 31, "format": "int64" }, "hours": { "type": "string", "pattern": "^\\d{1,2}(\\.\\d{1,2})?$" }, "type": { "type": "string", "enum": [ "work", "business_trip", "vacation", "sick", "holiday", "unpaid" ] } }, "required": [ "day", "hours", "type" ], "additionalProperties": false } }, "workedDays": { "type": "string", "pattern": "^[\\s\\S]*$" }, "workedHours": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "employeeName", "year", "month", "days", "workedDays", "workedHours", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/timesheets/list": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "days": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "integer", "minimum": 1, "maximum": 31, "format": "int64" }, "hours": { "type": "string", "pattern": "^\\d{1,2}(\\.\\d{1,2})?$" }, "type": { "type": "string", "enum": [ "work", "business_trip", "vacation", "sick", "holiday", "unpaid" ] } }, "required": [ "day", "hours", "type" ], "additionalProperties": false } }, "workedDays": { "type": "string", "pattern": "^[\\s\\S]*$" }, "workedHours": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "employeeName", "year", "month", "days", "workedDays", "workedHours", "updatedAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/hr/timesheets/delete": { "post": { "tags": [ "hr" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/departments/create": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/departments/list": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/schedules/create": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "hoursPerWeek": { "default": "40", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "hoursPerWeek": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "hoursPerWeek" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/schedules/list": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "hoursPerWeek": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "hoursPerWeek" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/calc": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "taxableBase": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "applyNpd": { "default": true, "type": "boolean" }, "npdOverride": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" }, "pensionAccumulation": { "default": false, "type": "boolean" }, "fixedTerm": { "default": false, "type": "boolean" } }, "required": [ "taxableBase", "date" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "npd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gpm": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployee": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployer": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "npd", "gpm", "sodraEmployee", "sodraEmployer", "net" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/runs/create": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "format": "int64" }, "lines": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" }, "additions": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" }, "taxable": { "default": true, "type": "boolean" } }, "required": [ "name", "amount" ] } }, "deductions": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" } }, "required": [ "name", "amount" ] } } }, "required": [ "employeeId" ] } }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "year", "month" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "draft", "approved" ] }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "npdTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gpmTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployeeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployerTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "approvedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "additions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "taxable": { "type": "boolean" } }, "required": [ "name", "amount", "taxable" ], "additionalProperties": false } }, "deductions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name", "amount" ], "additionalProperties": false } }, "taxableBase": { "type": "string", "pattern": "^[\\s\\S]*$" }, "npd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gpm": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployee": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployer": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "contractId", "employeeName", "gross", "additions", "deductions", "taxableBase", "npd", "gpm", "sodraEmployee", "sodraEmployer", "net" ], "additionalProperties": false } } }, "required": [ "id", "year", "month", "status", "grossTotal", "npdTotal", "gpmTotal", "sodraEmployeeTotal", "sodraEmployerTotal", "netTotal", "journalTransactionId", "notes", "createdAt", "approvedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/runs/get": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "draft", "approved" ] }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "npdTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gpmTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployeeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployerTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "approvedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "contractId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "additions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "taxable": { "type": "boolean" } }, "required": [ "name", "amount", "taxable" ], "additionalProperties": false } }, "deductions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name", "amount" ], "additionalProperties": false } }, "taxableBase": { "type": "string", "pattern": "^[\\s\\S]*$" }, "npd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gpm": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployee": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployer": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "employeeId", "contractId", "employeeName", "gross", "additions", "deductions", "taxableBase", "npd", "gpm", "sodraEmployee", "sodraEmployer", "net" ], "additionalProperties": false } } }, "required": [ "id", "year", "month", "status", "grossTotal", "npdTotal", "gpmTotal", "sodraEmployeeTotal", "sodraEmployerTotal", "netTotal", "journalTransactionId", "notes", "createdAt", "approvedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/runs/list": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "draft", "approved" ] }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "npdTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gpmTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployeeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployerTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "approvedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "year", "month", "status", "grossTotal", "npdTotal", "gpmTotal", "sodraEmployeeTotal", "sodraEmployerTotal", "netTotal", "journalTransactionId", "notes", "createdAt", "approvedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/runs/approve": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "wageAccountCode": { "default": "6204", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "employerAccountCode": { "default": "6205", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "payableAccountCode": { "default": "4460", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "gpmAccountCode": { "default": "4461", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "sodraAccountCode": { "default": "4463", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "deductionAccountCode": { "default": "2435", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "status": { "type": "string", "enum": [ "draft", "approved" ] }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "npdTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gpmTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployeeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sodraEmployerTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "approvedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "year", "month", "status", "grossTotal", "npdTotal", "gpmTotal", "sodraEmployeeTotal", "sodraEmployerTotal", "netTotal", "journalTransactionId", "notes", "createdAt", "approvedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/runs/cancel": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/payroll/payments/export": { "post": { "tags": [ "payroll" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "runId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "executionDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "runId", "bankAccountId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "transactionCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "controlSum": { "type": "string", "pattern": "^[\\s\\S]*$" }, "xml": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "messageId", "fileName", "transactionCount", "controlSum", "xml" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/types/create": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/types/list": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/agreements/create": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "startDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "autoRenew": { "default": false, "type": "boolean" }, "value": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "billingPeriod": { "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "currency": { "default": "EUR", "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "status": { "default": "active", "type": "string", "enum": [ "draft", "active", "expired", "terminated" ] }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "items": { "default": [], "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "unitPrice": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "description" ] } } }, "required": [ "partnerId", "number", "startDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "typeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "startDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "autoRenew": { "type": "boolean" }, "value": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "billingPeriod": { "nullable": true, "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "active", "expired", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPrice", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "typeId", "partnerId", "number", "name", "startDate", "endDate", "autoRenew", "value", "billingPeriod", "currency", "status", "notes", "createdAt", "items" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/agreements/get": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "typeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "startDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "autoRenew": { "type": "boolean" }, "value": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "billingPeriod": { "nullable": true, "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "active", "expired", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPrice", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "typeId", "partnerId", "number", "name", "startDate", "endDate", "autoRenew", "value", "billingPeriod", "currency", "status", "notes", "createdAt", "items" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/agreements/update": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "typeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "autoRenew": { "type": "boolean" }, "value": { "nullable": true, "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "billingPeriod": { "nullable": true, "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "status": { "type": "string", "enum": [ "draft", "active", "expired", "terminated" ] }, "notes": { "nullable": true, "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "typeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "startDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "autoRenew": { "type": "boolean" }, "value": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "billingPeriod": { "nullable": true, "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "active", "expired", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPrice": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPrice", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "typeId", "partnerId", "number", "name", "startDate", "endDate", "autoRenew", "value", "billingPeriod", "currency", "status", "notes", "createdAt", "items" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/agreements/delete": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/agreements/list": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "typeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "startDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "autoRenew": { "type": "boolean" }, "value": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "billingPeriod": { "nullable": true, "type": "string", "enum": [ "monthly", "quarterly", "annual" ] }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "active", "expired", "terminated" ] }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "typeId", "partnerId", "number", "name", "startDate", "endDate", "autoRenew", "value", "billingPeriod", "currency", "status", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/agreements/generate-invoice": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "asOfDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "periodStart": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodEnd": { "type": "string", "pattern": "^[\\s\\S]*$" }, "renewedEndDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "invoiceId", "periodStart", "periodEnd", "renewedEndDate" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/agreements/billing/run": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asOfDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated": { "type": "array", "items": { "type": "object", "properties": { "agreementId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "periodStart": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodEnd": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "agreementId", "invoiceId", "periodStart", "periodEnd" ], "additionalProperties": false } }, "expired": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "agreementId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "message": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "agreementId", "message" ], "additionalProperties": false } } }, "required": [ "generated", "expired", "errors" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/insurance-policies/create": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "insurerPartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "policyNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "insuredObject": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "premium": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "currency": { "default": "EUR", "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "policyNumber", "insuredObject", "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "insurerPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "policyNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "insuredObject": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "premium": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "insurerPartnerId", "policyNumber", "insuredObject", "fromDate", "toDate", "premium", "currency", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/insurance-policies/list": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "insurerPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "policyNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "insuredObject": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "premium": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "insurerPartnerId", "policyNumber", "insuredObject", "fromDate", "toDate", "premium", "currency", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/agreements/insurance-policies/delete": { "post": { "tags": [ "agreements" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/settings/get": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "negativeStockPolicy": { "type": "string", "enum": [ "reject", "allow" ] } }, "required": [ "negativeStockPolicy" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/settings/update": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "negativeStockPolicy": { "type": "string", "enum": [ "reject", "allow" ] } }, "required": [ "negativeStockPolicy" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "negativeStockPolicy": { "type": "string", "enum": [ "reject", "allow" ] } }, "required": [ "negativeStockPolicy" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/warehouses/create": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "isDefault": { "default": false, "type": "boolean" } }, "required": [ "code", "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "isDefault", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/warehouses/list": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name", "isDefault", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/stock/receive": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "quantity": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" }, "unitCost": { "type": "string", "pattern": "^\\d{1,13}(\\.\\d{1,6})?$" }, "notes": { "type": "string", "maxLength": 500, "pattern": "^[\\s\\S]*$" } }, "required": [ "warehouseId", "itemId", "date", "quantity", "unitCost" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "movementId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "movementId", "totalCost" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/stock/write-off": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "quantity": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" }, "expenseAccountCode": { "default": "6209", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "inventoryAccountCode": { "default": "2040", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 500, "pattern": "^[\\s\\S]*$" } }, "required": [ "warehouseId", "itemId", "date", "quantity" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "movementId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "movementId", "totalCost", "journalTransactionId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/stock/transfer": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromWarehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "toWarehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "quantity": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" }, "notes": { "type": "string", "maxLength": 500, "pattern": "^[\\s\\S]*$" } }, "required": [ "fromWarehouseId", "toWarehouseId", "itemId", "date", "quantity" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "outMovementId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "inMovementId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "outMovementId", "inMovementId", "totalCost" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/stock/take": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "expenseAccountCode": { "default": "6209", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "inventoryAccountCode": { "default": "2040", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "lines": { "minItems": 1, "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "barcode": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "countedQty": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" }, "unitCost": { "type": "string", "pattern": "^\\d{1,13}(\\.\\d{1,6})?$" } }, "required": [ "countedQty" ] } } }, "required": [ "warehouseId", "date", "lines" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "onHand": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counted": { "type": "string", "pattern": "^[\\s\\S]*$" }, "difference": { "type": "string", "pattern": "^[\\s\\S]*$" }, "adjustmentCost": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "onHand", "counted", "difference", "adjustmentCost" ], "additionalProperties": false } }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "rows", "journalTransactionId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/stock/levels": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "value": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "warehouseId", "quantity", "value" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/inventory/stock/movements/list": { "post": { "tags": [ "inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "direction": { "type": "string", "enum": [ "in", "out" ] }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitCost": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remainingQty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "warehouseId", "itemId", "date", "direction", "quantity", "unitCost", "totalCost", "remainingQty", "documentType", "documentId", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/production/boms/create": { "post": { "tags": [ "production" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "finishedItemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "outputQuantity": { "default": "1", "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" }, "lines": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "componentItemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" } }, "required": [ "componentItemId", "quantity" ] } } }, "required": [ "code", "name", "finishedItemId", "lines" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "finishedItemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "outputQuantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "componentItemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "componentItemId", "quantity" ], "additionalProperties": false } } }, "required": [ "id", "code", "name", "finishedItemId", "outputQuantity", "isActive", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/production/boms/get": { "post": { "tags": [ "production" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "finishedItemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "outputQuantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "componentItemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "componentItemId", "quantity" ], "additionalProperties": false } } }, "required": [ "id", "code", "name", "finishedItemId", "outputQuantity", "isActive", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/production/boms/list": { "post": { "tags": [ "production" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "finishedItemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "outputQuantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" } }, "required": [ "id", "code", "name", "finishedItemId", "outputQuantity", "isActive" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/production/orders/create": { "post": { "tags": [ "production" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "default": "assembly", "type": "string", "enum": [ "assembly", "disassembly" ] }, "bomId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "bomId", "warehouseId", "quantity", "date" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "assembly", "disassembly" ] }, "bomId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "completed" ] }, "totalCost": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "bomId", "warehouseId", "quantity", "date", "status", "totalCost", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/production/orders/complete": { "post": { "tags": [ "production" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "componentsAccountCode": { "default": "2040", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "finishedAccountCode": { "default": "2030", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "assembly", "disassembly" ] }, "bomId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "completed" ] }, "totalCost": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "bomId", "warehouseId", "quantity", "date", "status", "totalCost", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/production/orders/get": { "post": { "tags": [ "production" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "assembly", "disassembly" ] }, "bomId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "completed" ] }, "totalCost": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "bomId", "warehouseId", "quantity", "date", "status", "totalCost", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/production/orders/list": { "post": { "tags": [ "production" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "assembly", "disassembly" ] }, "bomId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "completed" ] }, "totalCost": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "bomId", "warehouseId", "quantity", "date", "status", "totalCost", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/orders/create": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "default": "api", "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "externalRef": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partner": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "code": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "shipToCountryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" }, "marketplace": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "lines": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" }, "unitPriceExclVat": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "vatRatePercent": { "default": "21.00", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" } }, "required": [ "description", "quantity", "unitPriceExclVat" ] } } }, "required": [ "lines" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "reserved", "fulfilled", "cancelled" ] }, "invoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "shipToCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "marketplace": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPriceExclVat", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "channel", "externalRef", "partnerId", "warehouseId", "currency", "status", "invoiceId", "shipToCountryCode", "marketplace", "notes", "createdAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/orders/get": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "reserved", "fulfilled", "cancelled" ] }, "invoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "shipToCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "marketplace": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPriceExclVat", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "channel", "externalRef", "partnerId", "warehouseId", "currency", "status", "invoiceId", "shipToCountryCode", "marketplace", "notes", "createdAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/orders/list": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "reserved", "fulfilled", "cancelled" ] }, "invoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "shipToCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "marketplace": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "channel", "externalRef", "partnerId", "warehouseId", "currency", "status", "invoiceId", "shipToCountryCode", "marketplace", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/orders/reserve": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "reserved", "fulfilled", "cancelled" ] }, "invoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "shipToCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "marketplace": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPriceExclVat", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "channel", "externalRef", "partnerId", "warehouseId", "currency", "status", "invoiceId", "shipToCountryCode", "marketplace", "notes", "createdAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/orders/fulfill": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "cogsAccountCode": { "default": "6000", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "inventoryAccountCode": { "default": "2040", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "reserved", "fulfilled", "cancelled" ] }, "invoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "shipToCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "marketplace": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPriceExclVat", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "channel", "externalRef", "partnerId", "warehouseId", "currency", "status", "invoiceId", "shipToCountryCode", "marketplace", "notes", "createdAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/orders/cancel": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "externalRef": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "reserved", "fulfilled", "cancelled" ] }, "invoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "shipToCountryCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "marketplace": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unitPriceExclVat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "itemId", "description", "quantity", "unitPriceExclVat", "vatRatePercent" ], "additionalProperties": false } } }, "required": [ "id", "channel", "externalRef", "partnerId", "warehouseId", "currency", "status", "invoiceId", "shipToCountryCode", "marketplace", "notes", "createdAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/products/list": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "priceListId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "updatedSince": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "product", "service", "set" ] }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "barcode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "translations": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ], "additionalProperties": false }, "maxProperties": 100 }, "attributes": { "nullable": true, "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\s\\S]*$" }, "maxProperties": 100 }, "groupId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "groupName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "price": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "components": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "quantity" ], "additionalProperties": false } }, "onHand": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "reserved": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "available": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "deleted": { "type": "boolean" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "name", "code", "barcode", "unit", "description", "translations", "attributes", "groupId", "groupName", "vatRatePercent", "price", "currency", "components", "onHand", "reserved", "available", "deleted", "updatedAt" ], "additionalProperties": false } } }, "required": [ "total", "page", "pageSize", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/ecommerce/stock/list": { "post": { "tags": [ "ecommerce" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "onHand": { "type": "string", "pattern": "^[\\s\\S]*$" }, "reserved": { "type": "string", "pattern": "^[\\s\\S]*$" }, "available": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "warehouseId", "onHand", "reserved", "available" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/cash/orders/create": { "post": { "tags": [ "cash" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "receipt", "disbursement" ] }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "amount": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "purpose": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" }, "counterAccountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "cashAccountCode": { "default": "2720", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "series": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "type", "date", "amount", "purpose", "counterAccountCode" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "receipt", "disbursement" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "purpose": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cashAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counterAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "series", "number", "fullNumber", "date", "partnerId", "employeeId", "amount", "currency", "purpose", "cashAccountCode", "counterAccountCode", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/cash/orders/get": { "post": { "tags": [ "cash" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "receipt", "disbursement" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "purpose": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cashAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counterAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "series", "number", "fullNumber", "date", "partnerId", "employeeId", "amount", "currency", "purpose", "cashAccountCode", "counterAccountCode", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/cash/orders/list": { "post": { "tags": [ "cash" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "receipt", "disbursement" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "number": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fullNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "employeeId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "purpose": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cashAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counterAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "type", "series", "number", "fullNumber", "date", "partnerId", "employeeId", "amount", "currency", "purpose", "cashAccountCode", "counterAccountCode", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/cash/balance": { "post": { "tags": [ "cash" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cashAccountCode": { "default": "2720", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "asOf": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "cashAccountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "balance": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "cashAccountCode", "balance" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/cash/advance-holders/balances": { "post": { "tags": [ "cash" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "issued": { "type": "string", "pattern": "^[\\s\\S]*$" }, "returned": { "type": "string", "pattern": "^[\\s\\S]*$" }, "balance": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "firstName", "lastName", "issued", "returned", "balance" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/transport/waybills/create": { "post": { "tags": [ "transport" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dispatchAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "estimatedArrivalAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "vehiclePlate": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "driverName": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "driverSurname": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "valueEur": { "type": "string", "pattern": "^\\d{1,16}(\\.\\d{1,2})?$" }, "saleInvoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "series": { "default": "VAZ", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "lines": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 350, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 24, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,9}(\\.\\d{1,3})?$" }, "productCode": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" } }, "required": [ "quantity" ] } } }, "required": [ "consigneePartnerId", "dispatchAt", "loadAddress", "unloadAddress" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "estimatedArrivalAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vehiclePlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverSurname": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "valueEur": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "productCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "productCode", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "status", "series", "fullNumber", "documentDate", "dispatchAt", "estimatedArrivalAt", "consigneePartnerId", "transporterPartnerId", "vehiclePlate", "trailerPlate", "driverName", "driverSurname", "loadWarehouseId", "loadAddress", "unloadAddress", "valueEur", "saleInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/transport/waybills/update": { "post": { "tags": [ "transport" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dispatchAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "estimatedArrivalAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "vehiclePlate": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "driverName": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "driverSurname": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "valueEur": { "type": "string", "pattern": "^\\d{1,16}(\\.\\d{1,2})?$" }, "saleInvoiceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "series": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "lines": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "minLength": 1, "maxLength": 350, "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "minLength": 1, "maxLength": 24, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,9}(\\.\\d{1,3})?$" }, "productCode": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" } }, "required": [ "quantity" ] } }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "estimatedArrivalAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vehiclePlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverSurname": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "valueEur": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "productCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "productCode", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "status", "series", "fullNumber", "documentDate", "dispatchAt", "estimatedArrivalAt", "consigneePartnerId", "transporterPartnerId", "vehiclePlate", "trailerPlate", "driverName", "driverSurname", "loadWarehouseId", "loadAddress", "unloadAddress", "valueEur", "saleInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/transport/waybills/issue": { "post": { "tags": [ "transport" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "estimatedArrivalAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vehiclePlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverSurname": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "valueEur": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "productCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "productCode", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "status", "series", "fullNumber", "documentDate", "dispatchAt", "estimatedArrivalAt", "consigneePartnerId", "transporterPartnerId", "vehiclePlate", "trailerPlate", "driverName", "driverSurname", "loadWarehouseId", "loadAddress", "unloadAddress", "valueEur", "saleInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/transport/waybills/cancel": { "post": { "tags": [ "transport" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "estimatedArrivalAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vehiclePlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverSurname": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "valueEur": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "status", "series", "fullNumber", "documentDate", "dispatchAt", "estimatedArrivalAt", "consigneePartnerId", "transporterPartnerId", "vehiclePlate", "trailerPlate", "driverName", "driverSurname", "loadWarehouseId", "loadAddress", "unloadAddress", "valueEur", "saleInvoiceId", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/transport/waybills/get": { "post": { "tags": [ "transport" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "estimatedArrivalAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vehiclePlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverSurname": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "valueEur": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "productCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sortOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "id", "itemId", "description", "unit", "quantity", "productCode", "sortOrder" ], "additionalProperties": false } } }, "required": [ "id", "status", "series", "fullNumber", "documentDate", "dispatchAt", "estimatedArrivalAt", "consigneePartnerId", "transporterPartnerId", "vehiclePlate", "trailerPlate", "driverName", "driverSurname", "loadWarehouseId", "loadAddress", "unloadAddress", "valueEur", "saleInvoiceId", "notes", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/transport/waybills/list": { "post": { "tags": [ "transport" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "draft", "issued", "cancelled" ] }, "series": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fullNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "dispatchAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "estimatedArrivalAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "consigneePartnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transporterPartnerId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vehiclePlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "trailerPlate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "driverSurname": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "loadWarehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "loadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "unloadAddress": { "type": "string", "pattern": "^[\\s\\S]*$" }, "valueEur": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "saleInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "status", "series", "fullNumber", "documentDate", "dispatchAt", "estimatedArrivalAt", "consigneePartnerId", "transporterPartnerId", "vehiclePlate", "trailerPlate", "driverName", "driverSurname", "loadWarehouseId", "loadAddress", "unloadAddress", "valueEur", "saleInvoiceId", "notes", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/pos/devices/create": { "post": { "tags": [ "pos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "serialNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "registrationNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "address": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" } }, "required": [ "name", "serialNumber" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "serialNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "model": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "serialNumber", "model", "registrationNumber", "address", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/pos/devices/update": { "post": { "tags": [ "pos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "serialNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "model": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "registrationNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "address": { "type": "string", "minLength": 1, "maxLength": 500, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "serialNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "model": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "serialNumber", "model", "registrationNumber", "address", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/pos/devices/list": { "post": { "tags": [ "pos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "serialNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "model": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "registrationNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "address": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "serialNumber", "model", "registrationNumber", "address", "isActive", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/pos/reports/create": { "post": { "tags": [ "pos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reportNumber": { "type": "string", "minLength": 1, "maxLength": 70, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "deviceId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "vatLines": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "vatRatePercent": { "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,2})?$" }, "netAmount": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "vatAmount": { "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" } }, "required": [ "vatRatePercent", "netAmount", "vatAmount" ] } }, "cashAmount": { "default": "0", "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "cardAmount": { "default": "0", "type": "string", "pattern": "^\\d{1,15}(\\.\\d{1,4})?$" }, "itemLines": { "default": [], "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^\\d{1,11}(\\.\\d{1,4})?$" } }, "required": [ "itemId", "quantity" ] } }, "cashAccountCode": { "default": "2720", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "cardAccountCode": { "default": "2435", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "revenueAccountCode": { "default": "5000", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "vatAccountCode": { "default": "4492", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "cogsAccountCode": { "default": "6000", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "inventoryAccountCode": { "default": "2040", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "notes": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" } }, "required": [ "reportNumber", "date", "vatLines" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "reportNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "deviceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cashAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cardAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cogsTotal": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatLines": { "type": "array", "items": { "type": "object", "properties": { "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "vatRatePercent", "netAmount", "vatAmount" ], "additionalProperties": false } } }, "required": [ "id", "reportNumber", "date", "deviceId", "warehouseId", "netTotal", "vatTotal", "grossTotal", "cashAmount", "cardAmount", "cogsTotal", "journalTransactionId", "notes", "createdAt", "vatLines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/pos/reports/get": { "post": { "tags": [ "pos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "reportNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "deviceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cashAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cardAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cogsTotal": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatLines": { "type": "array", "items": { "type": "object", "properties": { "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatAmount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "vatRatePercent", "netAmount", "vatAmount" ], "additionalProperties": false } } }, "required": [ "id", "reportNumber", "date", "deviceId", "warehouseId", "netTotal", "vatTotal", "grossTotal", "cashAmount", "cardAmount", "cogsTotal", "journalTransactionId", "notes", "createdAt", "vatLines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/pos/reports/list": { "post": { "tags": [ "pos" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "reportNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "deviceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "warehouseId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cashAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cardAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cogsTotal": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "reportNumber", "date", "deviceId", "warehouseId", "netTotal", "vatTotal", "grossTotal", "cashAmount", "cardAmount", "cogsTotal", "journalTransactionId", "notes", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/audit/list": { "post": { "tags": [ "audit" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "actorType": { "type": "string", "enum": [ "user", "api_key", "system" ] }, "actorId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "action": { "type": "string", "pattern": "^[\\s\\S]*$" }, "entity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "entityId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "diff": { "nullable": true }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "actorType", "actorId", "action", "entity", "entityId", "diff", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/subscriptions/create": { "post": { "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "events": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\s\\S]*$" } }, "secret": { "type": "string", "minLength": 16, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "url", "events" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "url": { "type": "string", "pattern": "^[\\s\\S]*$" }, "events": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "secret": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "url", "events", "isActive", "createdAt", "secret" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/subscriptions/list": { "post": { "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "url": { "type": "string", "pattern": "^[\\s\\S]*$" }, "events": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "url", "events", "isActive", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/subscriptions/update": { "post": { "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "events": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\s\\S]*$" } }, "isActive": { "type": "boolean" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "url": { "type": "string", "pattern": "^[\\s\\S]*$" }, "events": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "url", "events", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/subscriptions/delete": { "post": { "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/deliveries/list": { "post": { "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "subscriptionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "eventType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "pending", "delivered", "failed" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "lastError": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "deliveredAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "subscriptionId", "eventType", "status", "attempts", "lastError", "createdAt", "deliveredAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/deliveries/redeliver": { "post": { "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "status" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/accounts/create": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "iban": { "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "currency": { "default": "EUR", "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "accountCode": { "default": "2710", "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "iban", "currency", "accountCode", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/accounts/list": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "iban", "currency", "accountCode", "isActive", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/accounts/update": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "iban": { "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "iban", "currency", "accountCode", "isActive", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/transactions/import": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "transactions": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "amount": { "type": "string", "pattern": "^-?\\d{1,15}(\\.\\d{1,4})?$" }, "currency": { "default": "EUR", "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\s\\S]*$" }, "counterpartyName": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "counterpartyIban": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "maxLength": 1000, "pattern": "^[\\s\\S]*$" }, "externalId": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" } }, "required": [ "date", "amount" ] } } }, "required": [ "bankAccountId", "transactions" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "imported": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "imported", "skipped" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/statements/import": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "format": { "default": "camt053", "type": "string", "enum": [ "camt053", "mt940", "stripe-csv" ] }, "content": { "type": "string", "minLength": 1, "maxLength": 20000000, "pattern": "^[\\s\\S]*$" } }, "required": [ "bankAccountId", "content" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "imported": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "statements": { "type": "array", "items": { "type": "object", "properties": { "statementId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "openingBalance": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "closingBalance": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "transactionCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "statementId", "iban", "fromDate", "toDate", "openingBalance", "closingBalance", "transactionCount" ], "additionalProperties": false } } }, "required": [ "imported", "skipped", "statements" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/transactions/list": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counterpartyName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "counterpartyIban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "externalId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "matched" ] }, "matchedDocumentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "matchedDocumentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "bankAccountId", "date", "amount", "currency", "counterpartyName", "counterpartyIban", "description", "externalId", "status", "matchedDocumentType", "matchedDocumentId", "journalTransactionId", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/transactions/match": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "transactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "documentType": { "type": "string", "enum": [ "sale_invoice", "purchase_invoice" ] }, "documentId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "transactionId", "documentType", "documentId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "counterpartyName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "counterpartyIban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "externalId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "new", "matched" ] }, "matchedDocumentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "matchedDocumentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "bankAccountId", "date", "amount", "currency", "counterpartyName", "counterpartyIban", "description", "externalId", "status", "matchedDocumentType", "matchedDocumentId", "journalTransactionId", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/payments/export": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "purchaseInvoiceIds": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "executionDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "bankAccountId", "purchaseInvoiceIds" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "transactionCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "controlSum": { "type": "string", "pattern": "^[\\s\\S]*$" }, "xml": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "messageId", "fileName", "transactionCount", "controlSum", "xml" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/transactions/suggest-matches": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "transactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "limit": { "default": 5, "type": "integer", "minimum": 1, "maximum": 20, "format": "int64" } }, "required": [ "transactionId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "object", "properties": { "documentType": { "type": "string", "enum": [ "sale_invoice", "purchase_invoice" ] }, "documentId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "number": { "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "remaining": { "type": "string", "pattern": "^[\\s\\S]*$" }, "score": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "reasons": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } } }, "required": [ "documentType", "documentId", "number", "partnerName", "grossTotal", "remaining", "score", "reasons" ], "additionalProperties": false } } }, "required": [ "suggestions" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/settlements/import": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "provider": { "default": "stripe", "type": "string", "enum": [ "stripe" ] }, "content": { "type": "string", "minLength": 1, "maxLength": 20000000, "pattern": "^[\\s\\S]*$" } }, "required": [ "bankAccountId", "content" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "payout_reconciliation", "unified_payments" ] }, "imported": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "updated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "skippedUnassigned": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "skippedPayoutRows": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "skippedNotSettled": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "batches": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "feeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "imported", "posted" ] }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "matchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "unmatchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "bankAccountId", "provider", "payoutId", "payoutDate", "currency", "grossTotal", "feeTotal", "netTotal", "status", "journalTransactionId", "lineCount", "matchedCount", "unmatchedCount", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "format", "imported", "updated", "skipped", "skippedUnassigned", "skippedPayoutRows", "skippedNotSettled", "batches" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/settlements/list": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "feeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "imported", "posted" ] }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "matchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "unmatchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "bankAccountId", "provider", "payoutId", "payoutDate", "currency", "grossTotal", "feeTotal", "netTotal", "status", "journalTransactionId", "lineCount", "matchedCount", "unmatchedCount", "createdAt", "updatedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/settlements/get": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "feeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "imported", "posted" ] }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "matchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "unmatchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "externalId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "category": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fee": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sourceId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "chargeId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "reference": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "matchedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "matchStatus": { "type": "string", "enum": [ "unmatched", "matched", "manual" ] } }, "required": [ "id", "externalId", "category", "date", "gross", "fee", "net", "description", "sourceId", "chargeId", "reference", "matchedInvoiceId", "matchStatus" ], "additionalProperties": false } } }, "required": [ "id", "bankAccountId", "provider", "payoutId", "payoutDate", "currency", "grossTotal", "feeTotal", "netTotal", "status", "journalTransactionId", "lineCount", "matchedCount", "unmatchedCount", "createdAt", "updatedAt", "lines" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/settlements/match": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "lineId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "invoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "lineId", "invoiceId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "externalId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "category": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fee": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "sourceId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "chargeId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "reference": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "matchedInvoiceId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "matchStatus": { "type": "string", "enum": [ "unmatched", "matched", "manual" ] } }, "required": [ "id", "externalId", "category", "date", "gross", "fee", "net", "description", "sourceId", "chargeId", "reference", "matchedInvoiceId", "matchStatus" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/bank/settlements/post": { "post": { "tags": [ "bank" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "commissionPercent": { "type": "string", "pattern": "^(100(\\.00?)?|\\d{1,2}(\\.\\d{1,2})?)$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "bankAccountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payoutDate": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "currency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "feeTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netTotal": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "imported", "posted" ] }, "journalTransactionId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "lineCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "matchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "unmatchedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warnings": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "summary": { "type": "object", "properties": { "receivableApplied": { "type": "string", "pattern": "^[\\s\\S]*$" }, "commissionAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sellerAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "feeAmount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "suspenseAmount": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "receivableApplied", "commissionAmount", "sellerAmount", "feeAmount", "suspenseAmount" ], "additionalProperties": false } }, "required": [ "id", "bankAccountId", "provider", "payoutId", "payoutDate", "currency", "grossTotal", "feeTotal", "netTotal", "status", "journalTransactionId", "lineCount", "matchedCount", "unmatchedCount", "createdAt", "updatedAt", "warnings", "summary" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/files/upload": { "post": { "tags": [ "files" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "entityId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\s\\S]*$" }, "mimeType": { "type": "string", "minLength": 1, "maxLength": 150, "pattern": "^[\\s\\S]*$" }, "content": { "type": "string", "minLength": 1, "description": "Base64-encoded file content", "pattern": "^[\\s\\S]*$" } }, "required": [ "entity", "entityId", "fileName", "mimeType", "content" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "entity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "entityId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "mimeType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "sha256": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "entity", "entityId", "fileName", "mimeType", "sizeBytes", "sha256", "createdAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/files/get": { "post": { "tags": [ "files" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "entity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "entityId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "mimeType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "sha256": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "content": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "entity", "entityId", "fileName", "mimeType", "sizeBytes", "sha256", "createdAt", "content" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/files/list": { "post": { "tags": [ "files" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "entity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "entityId": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "mimeType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "sha256": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "entity", "entityId", "fileName", "mimeType", "sizeBytes", "sha256", "createdAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/files/delete": { "post": { "tags": [ "files" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/trial-balance": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "enum": [ "asset", "liability", "equity", "income", "expense" ] }, "opening": { "type": "string", "pattern": "^[\\s\\S]*$" }, "debit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "credit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closing": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "accountId", "code", "name", "type", "opening", "debit", "credit", "closing" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "debit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "credit": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "debit", "credit" ], "additionalProperties": false } }, "required": [ "fromDate", "toDate", "rows", "totals" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/size-category": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": 2000, "maximum": 2100, "format": "int64" } }, "required": [ "year" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "criteria": { "type": "object", "properties": { "totalAssets": { "type": "number" }, "netTurnover": { "type": "number" }, "avgEmployees": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "totalAssets", "netTurnover", "avgEmployees" ], "additionalProperties": false }, "category": { "type": "string", "enum": [ "micro", "small", "medium", "large" ] }, "thresholds": { "type": "object", "additionalProperties": { "type": "object", "properties": { "totalAssets": { "type": "number" }, "netTurnover": { "type": "number" }, "employees": { "type": "number" } }, "required": [ "totalAssets", "netTurnover", "employees" ], "additionalProperties": false }, "maxProperties": 100 } }, "required": [ "year", "criteria", "category", "thresholds" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/financial-statements": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "category": { "type": "string", "enum": [ "micro", "small", "medium", "large" ] } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "micro", "small", "medium", "large" ] }, "layout": { "type": "string", "pattern": "^[\\s\\S]*$" }, "requiredStatements": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "asOf": { "type": "string", "pattern": "^[\\s\\S]*$" }, "balanceSheet": { "type": "object", "properties": { "nonCurrentAssets": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currentAssets": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalAssets": { "type": "string", "pattern": "^[\\s\\S]*$" }, "equity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "ofWhichResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "liabilities": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalEquityAndLiabilities": { "type": "string", "pattern": "^[\\s\\S]*$" }, "balanced": { "type": "boolean" } }, "required": [ "nonCurrentAssets", "currentAssets", "totalAssets", "equity", "ofWhichResult", "liabilities", "totalEquityAndLiabilities", "balanced" ], "additionalProperties": false }, "profitLoss": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "revenue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netResult": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fromDate", "toDate", "revenue", "expenses", "netResult" ], "additionalProperties": false }, "balanceSheetDetail": { "type": "object", "properties": { "nonCurrentAssets": { "type": "object", "properties": { "intangible": { "type": "string", "pattern": "^[\\s\\S]*$" }, "tangible": { "type": "string", "pattern": "^[\\s\\S]*$" }, "financial": { "type": "string", "pattern": "^[\\s\\S]*$" }, "other": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "intangible", "tangible", "financial", "other", "total" ], "additionalProperties": false }, "currentAssets": { "type": "object", "properties": { "inventories": { "type": "string", "pattern": "^[\\s\\S]*$" }, "receivables": { "type": "string", "pattern": "^[\\s\\S]*$" }, "otherCurrent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cash": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "inventories", "receivables", "otherCurrent", "cash", "total" ], "additionalProperties": false }, "equity": { "type": "object", "properties": { "capital": { "type": "string", "pattern": "^[\\s\\S]*$" }, "reserves": { "type": "string", "pattern": "^[\\s\\S]*$" }, "retainedEarnings": { "type": "string", "pattern": "^[\\s\\S]*$" }, "otherEquity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "capital", "reserves", "retainedEarnings", "otherEquity", "periodResult", "total" ], "additionalProperties": false }, "liabilities": { "type": "object", "properties": { "nonCurrent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "current": { "type": "string", "pattern": "^[\\s\\S]*$" }, "other": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "nonCurrent", "current", "other", "total" ], "additionalProperties": false } }, "required": [ "nonCurrentAssets", "currentAssets", "equity", "liabilities" ], "additionalProperties": false }, "profitLossDetail": { "type": "object", "properties": { "salesRevenue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "costOfSales": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossProfit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sellingExpenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "adminExpenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "operatingProfit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "otherActivityResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "financialActivityResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "profitBeforeTax": { "type": "string", "pattern": "^[\\s\\S]*$" }, "incomeTax": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netProfit": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "salesRevenue", "costOfSales", "grossProfit", "sellingExpenses", "adminExpenses", "operatingProfit", "otherActivityResult", "financialActivityResult", "profitBeforeTax", "incomeTax", "netProfit" ], "additionalProperties": false }, "equityChanges": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "opening": { "type": "string", "pattern": "^[\\s\\S]*$" }, "increase": { "type": "string", "pattern": "^[\\s\\S]*$" }, "decrease": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closing": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "opening", "increase", "decrease", "closing" ], "additionalProperties": false } }, "cashFlow": { "type": "object", "properties": { "openingCash": { "type": "string", "pattern": "^[\\s\\S]*$" }, "operating": { "type": "string", "pattern": "^[\\s\\S]*$" }, "investing": { "type": "string", "pattern": "^[\\s\\S]*$" }, "financing": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netChange": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closingCash": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "openingCash", "operating", "investing", "financing", "netChange", "closingCash" ], "additionalProperties": false } }, "required": [ "category", "layout", "requiredStatements", "asOf", "balanceSheet", "profitLoss" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/general-journal": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200, "format": "int64" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "debit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "credit": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "accountCode", "accountName", "debit", "credit" ], "additionalProperties": false } } }, "required": [ "id", "date", "description", "documentType", "documentId", "entries" ], "additionalProperties": false } } }, "required": [ "total", "page", "pageSize", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/gl-detail": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "accountCode", "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "account": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "type" ], "additionalProperties": false }, "opening": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closing": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "description": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentType": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "documentId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "journalTransactionId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "debit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "credit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "balance": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "date", "description", "documentType", "documentId", "journalTransactionId", "debit", "credit", "balance" ], "additionalProperties": false } } }, "required": [ "account", "opening", "closing", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/partner-balances": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "receivable": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payable": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "partnerId", "partnerName", "receivable", "payable", "net" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/debt-aging": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "side": { "default": "receivables", "type": "string", "enum": [ "receivables", "payables" ] }, "asOf": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "pattern": "^[\\s\\S]*$" }, "side": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "current": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d1to30": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d31to60": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d61to90": { "type": "string", "pattern": "^[\\s\\S]*$" }, "over90": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "partnerId", "partnerName", "current", "d1to30", "d31to60", "d61to90", "over90", "total" ], "additionalProperties": false } } }, "required": [ "asOf", "side", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/monthly-summary": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "months": { "default": 12, "type": "integer", "minimum": 1, "maximum": 36, "format": "int64" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "month": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "receivables": { "type": "string", "pattern": "^[\\s\\S]*$" }, "payables": { "type": "string", "pattern": "^[\\s\\S]*$" }, "revenue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netResult": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "year", "month", "receivables", "payables", "revenue", "expenses", "netResult" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/stock-balance": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "asOf" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "value": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "warehouseId", "quantity", "value" ], "additionalProperties": false } }, "totalValue": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "asOf", "rows", "totalValue" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/stock-movement": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "openingQty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "openingValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "inQty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "inValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outQty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outValue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closingQty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closingValue": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "openingQty", "openingValue", "inQty", "inValue", "outQty", "outValue", "closingQty", "closingValue" ], "additionalProperties": false } } }, "required": [ "fromDate", "toDate", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/vat-summary": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "side": { "default": "sales", "type": "string", "enum": [ "sales", "purchases" ] } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "side": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "vatRatePercent", "net", "vat", "gross", "documents" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "net", "vat", "gross" ], "additionalProperties": false } }, "required": [ "side", "fromDate", "toDate", "rows", "totals" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/cash-flow": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "openingCash": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closingCash": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netChange": { "type": "string", "pattern": "^[\\s\\S]*$" }, "operating": { "type": "object", "properties": { "inflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "inflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outflow": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "inflow", "outflow" ], "additionalProperties": false } } }, "required": [ "inflow", "outflow", "net", "rows" ], "additionalProperties": false }, "investing": { "type": "object", "properties": { "inflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "inflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outflow": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "inflow", "outflow" ], "additionalProperties": false } } }, "required": [ "inflow", "outflow", "net", "rows" ], "additionalProperties": false }, "financing": { "type": "object", "properties": { "inflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "inflow": { "type": "string", "pattern": "^[\\s\\S]*$" }, "outflow": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "name", "inflow", "outflow" ], "additionalProperties": false } } }, "required": [ "inflow", "outflow", "net", "rows" ], "additionalProperties": false }, "balanced": { "type": "boolean" } }, "required": [ "fromDate", "toDate", "openingCash", "closingCash", "netChange", "operating", "investing", "financing", "balanced" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/stock-aging": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "asOf" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "d0to30Qty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d0to30Value": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d31to60Qty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d31to60Value": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d61to90Qty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "d61to90Value": { "type": "string", "pattern": "^[\\s\\S]*$" }, "over90Qty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "over90Value": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalQty": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalValue": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "warehouseId", "d0to30Qty", "d0to30Value", "d31to60Qty", "d31to60Value", "d61to90Qty", "d61to90Value", "over90Qty", "over90Value", "totalQty", "totalValue" ], "additionalProperties": false } }, "totalValue": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "asOf", "rows", "totalValue" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/stock-shortage": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "onHand": { "type": "string", "pattern": "^[\\s\\S]*$" }, "reserved": { "type": "string", "pattern": "^[\\s\\S]*$" }, "shortage": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "itemId", "itemName", "warehouseId", "onHand", "reserved", "shortage" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/eu-purchases": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "countryCode", "vatRatePercent", "net", "vat", "documents" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "net", "vat" ], "additionalProperties": false } }, "required": [ "fromDate", "toDate", "rows", "totals" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/vat-detail": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "side": { "default": "sales", "type": "string", "enum": [ "sales", "purchases" ] } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "side": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "documentNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "documentId", "documentNumber", "date", "partnerName", "vatRatePercent", "net", "vat", "gross" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "net", "vat", "gross" ], "additionalProperties": false } }, "required": [ "side", "fromDate", "toDate", "rows", "totals" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/pos-sales": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "reportId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "reportNumber": { "type": "string", "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cash": { "type": "string", "pattern": "^[\\s\\S]*$" }, "card": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cogs": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "reportId", "reportNumber", "date", "net", "vat", "gross", "cash", "card", "cogs" ], "additionalProperties": false } }, "byRate": { "type": "array", "items": { "type": "object", "properties": { "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "vatRatePercent", "net", "vat" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cash": { "type": "string", "pattern": "^[\\s\\S]*$" }, "card": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cogs": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "net", "vat", "gross", "cash", "card", "cogs" ], "additionalProperties": false } }, "required": [ "fromDate", "toDate", "rows", "byRate", "totals" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/online-sales": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string", "pattern": "^[\\s\\S]*$" }, "orders": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "fulfilled": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "cancelled": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "open": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "gross": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "channel", "orders", "fulfilled", "cancelled", "open", "net", "gross" ], "additionalProperties": false } } }, "required": [ "fromDate", "toDate", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/oss": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vatRatePercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documents": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "countryCode", "vatRatePercent", "net", "vat", "documents" ], "additionalProperties": false } }, "totals": { "type": "object", "properties": { "net": { "type": "string", "pattern": "^[\\s\\S]*$" }, "vat": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "net", "vat" ], "additionalProperties": false } }, "required": [ "fromDate", "toDate", "rows", "totals" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/advance-reconciliation": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "firstName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "lastName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "opening": { "type": "string", "pattern": "^[\\s\\S]*$" }, "issued": { "type": "string", "pattern": "^[\\s\\S]*$" }, "returned": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closing": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "employeeId", "firstName", "lastName", "opening", "issued", "returned", "closing" ], "additionalProperties": false } } }, "required": [ "fromDate", "toDate", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/write-off-acts": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "movementId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "date": { "type": "string", "pattern": "^[\\s\\S]*$" }, "documentType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "warehouseCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "quantity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" }, "notes": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "movementId", "date", "documentType", "itemName", "warehouseCode", "quantity", "totalCost", "notes" ], "additionalProperties": false } }, "totalCost": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fromDate", "toDate", "rows", "totalCost" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/cost-centers": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "income": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "result": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "costCenterId", "code", "name", "income", "expenses", "result" ], "additionalProperties": false } } }, "required": [ "fromDate", "toDate", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/cost-center-activity": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "fromDate", "toDate", "costCenterId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "costCenter": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "code", "name" ], "additionalProperties": false }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "accountCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "accountName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "debit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "credit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "accountCode", "accountName", "debit", "credit", "net" ], "additionalProperties": false } } }, "required": [ "costCenter", "fromDate", "toDate", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/cost-center-items": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "costCenterId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "costCenterCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "costCenterName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "itemName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "costCenterCode", "costCenterName", "itemName", "net" ], "additionalProperties": false } } }, "required": [ "fromDate", "toDate", "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/jobs/create": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reportType": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "params": { "default": {}, "type": "object", "additionalProperties": {}, "maxProperties": 100 }, "formats": { "default": [ "json" ], "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "json", "xlsx", "pdf" ] } } }, "required": [ "reportType" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "reportType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "params": {}, "formats": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "error": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "outputs": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "format": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "format", "fileId", "fileName", "sizeBytes" ], "additionalProperties": false } }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "startedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "finishedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "reportType", "params", "formats", "status", "error", "outputs", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/jobs/get": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "reportType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "params": {}, "formats": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "error": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "outputs": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "format": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "format", "fileId", "fileName", "sizeBytes" ], "additionalProperties": false } }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "startedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "finishedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "reportType", "params", "formats", "status", "error", "outputs", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/reports/jobs/list": { "post": { "tags": [ "reports" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500, "format": "int64" }, "sort": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "dir": { "default": "asc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field" ] } }, "filter": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "op": { "type": "string", "enum": [ "eq", "ne", "contains", "gte", "lte", "in" ] }, "value": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" }, { "type": "boolean" }, { "minItems": 1, "maxItems": 100, "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\s\\S]*$" }, { "type": "number" } ] } } ] } }, "required": [ "field", "op", "value" ] } } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "reportType": { "type": "string", "pattern": "^[\\s\\S]*$" }, "params": {}, "formats": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "error": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "outputs": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "format": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fileId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "fileName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "format", "fileId", "fileName", "sizeBytes" ], "additionalProperties": false } }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "startedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "finishedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "reportType", "params", "formats", "status", "error", "outputs", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "rows", "page", "pageSize", "total" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/groups/create": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "presentationCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "presentationCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "presentationCurrency", "memberCount", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/groups/list": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "presentationCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "presentationCurrency", "memberCount", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/groups/get": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "presentationCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "members": { "type": "array", "items": { "type": "object", "properties": { "memberCompanyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "baseCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "ownershipPercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "method": { "type": "string", "enum": [ "full", "proportional", "equity" ] } }, "required": [ "memberCompanyId", "name", "baseCurrency", "ownershipPercent", "method" ], "additionalProperties": false } } }, "required": [ "id", "name", "presentationCurrency", "memberCount", "createdAt", "updatedAt", "members" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/groups/update": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "presentationCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "presentationCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "format": "int64" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "updatedAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "presentationCurrency", "memberCount", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/groups/delete": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/members/add": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "memberCompanyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "ownershipPercent": { "default": 100, "type": "number", "minimum": 0, "maximum": 100 }, "method": { "default": "full", "type": "string", "enum": [ "full", "proportional", "equity" ] } }, "required": [ "groupId", "memberCompanyId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "memberCompanyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "baseCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "ownershipPercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "method": { "type": "string", "enum": [ "full", "proportional", "equity" ] } }, "required": [ "memberCompanyId", "name", "baseCurrency", "ownershipPercent", "method" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/members/remove": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "memberCompanyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "groupId", "memberCompanyId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/consolidation/report": { "post": { "tags": [ "consolidation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "toDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "category": { "default": "large", "type": "string", "enum": [ "micro", "small", "medium", "large" ] }, "eliminations": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "note": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "amount" ] } } }, "required": [ "groupId", "fromDate", "toDate" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "presentationCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "category": { "type": "string", "enum": [ "micro", "small", "medium", "large" ] }, "statements": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "micro", "small", "medium", "large" ] }, "layout": { "type": "string", "pattern": "^[\\s\\S]*$" }, "requiredStatements": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "asOf": { "type": "string", "pattern": "^[\\s\\S]*$" }, "balanceSheet": { "type": "object", "properties": { "nonCurrentAssets": { "type": "string", "pattern": "^[\\s\\S]*$" }, "currentAssets": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalAssets": { "type": "string", "pattern": "^[\\s\\S]*$" }, "equity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "ofWhichResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "liabilities": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalEquityAndLiabilities": { "type": "string", "pattern": "^[\\s\\S]*$" }, "balanced": { "type": "boolean" } }, "required": [ "nonCurrentAssets", "currentAssets", "totalAssets", "equity", "ofWhichResult", "liabilities", "totalEquityAndLiabilities", "balanced" ], "additionalProperties": false }, "profitLoss": { "type": "object", "properties": { "fromDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "toDate": { "type": "string", "pattern": "^[\\s\\S]*$" }, "revenue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netResult": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "fromDate", "toDate", "revenue", "expenses", "netResult" ], "additionalProperties": false }, "balanceSheetDetail": { "type": "object", "properties": { "nonCurrentAssets": { "type": "object", "properties": { "intangible": { "type": "string", "pattern": "^[\\s\\S]*$" }, "tangible": { "type": "string", "pattern": "^[\\s\\S]*$" }, "financial": { "type": "string", "pattern": "^[\\s\\S]*$" }, "other": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "intangible", "tangible", "financial", "other", "total" ], "additionalProperties": false }, "currentAssets": { "type": "object", "properties": { "inventories": { "type": "string", "pattern": "^[\\s\\S]*$" }, "receivables": { "type": "string", "pattern": "^[\\s\\S]*$" }, "otherCurrent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "cash": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "inventories", "receivables", "otherCurrent", "cash", "total" ], "additionalProperties": false }, "equity": { "type": "object", "properties": { "capital": { "type": "string", "pattern": "^[\\s\\S]*$" }, "reserves": { "type": "string", "pattern": "^[\\s\\S]*$" }, "retainedEarnings": { "type": "string", "pattern": "^[\\s\\S]*$" }, "otherEquity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "capital", "reserves", "retainedEarnings", "otherEquity", "periodResult", "total" ], "additionalProperties": false }, "liabilities": { "type": "object", "properties": { "nonCurrent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "current": { "type": "string", "pattern": "^[\\s\\S]*$" }, "other": { "type": "string", "pattern": "^[\\s\\S]*$" }, "total": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "nonCurrent", "current", "other", "total" ], "additionalProperties": false } }, "required": [ "nonCurrentAssets", "currentAssets", "equity", "liabilities" ], "additionalProperties": false }, "profitLossDetail": { "type": "object", "properties": { "salesRevenue": { "type": "string", "pattern": "^[\\s\\S]*$" }, "costOfSales": { "type": "string", "pattern": "^[\\s\\S]*$" }, "grossProfit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "sellingExpenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "adminExpenses": { "type": "string", "pattern": "^[\\s\\S]*$" }, "operatingProfit": { "type": "string", "pattern": "^[\\s\\S]*$" }, "otherActivityResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "financialActivityResult": { "type": "string", "pattern": "^[\\s\\S]*$" }, "profitBeforeTax": { "type": "string", "pattern": "^[\\s\\S]*$" }, "incomeTax": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netProfit": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "salesRevenue", "costOfSales", "grossProfit", "sellingExpenses", "adminExpenses", "operatingProfit", "otherActivityResult", "financialActivityResult", "profitBeforeTax", "incomeTax", "netProfit" ], "additionalProperties": false } }, "required": [ "category", "layout", "requiredStatements", "asOf", "balanceSheet", "profitLoss" ], "additionalProperties": false }, "trialBalance": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "pattern": "^[\\s\\S]*$" }, "closing": { "type": "string", "pattern": "^[\\s\\S]*$" }, "period": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "type", "closing", "period" ], "additionalProperties": false } }, "nonControllingInterest": { "type": "object", "properties": { "equity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "result": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "equity", "result" ], "additionalProperties": false }, "equityMethod": { "type": "object", "properties": { "investmentsInAssociates": { "type": "string", "pattern": "^[\\s\\S]*$" }, "shareOfAssociatesResult": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "investmentsInAssociates", "shareOfAssociatesResult" ], "additionalProperties": false }, "members": { "type": "array", "items": { "type": "object", "properties": { "companyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "baseCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "ownershipPercent": { "type": "string", "pattern": "^[\\s\\S]*$" }, "method": { "type": "string", "enum": [ "full", "proportional", "equity" ] }, "fxFactor": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rateFrom": { "type": "string", "pattern": "^[\\s\\S]*$" }, "rateTo": { "type": "string", "pattern": "^[\\s\\S]*$" }, "totalAssets": { "type": "string", "pattern": "^[\\s\\S]*$" }, "netEquity": { "type": "string", "pattern": "^[\\s\\S]*$" }, "periodResult": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "companyId", "name", "baseCurrency", "ownershipPercent", "method", "fxFactor", "rateFrom", "rateTo", "totalAssets", "netEquity", "periodResult" ], "additionalProperties": false } }, "eliminations": { "type": "object", "properties": { "applied": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[\\s\\S]*$" }, "amount": { "type": "string", "pattern": "^[\\s\\S]*$" }, "note": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "code", "amount" ], "additionalProperties": false } }, "balanced": { "type": "boolean" }, "net": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "applied", "balanced", "net" ], "additionalProperties": false }, "intercompanyCandidates": { "type": "array", "items": { "type": "object", "properties": { "memberCompanyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "memberName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "partnerName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "partnerCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "matchesCompanyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "matchesCompanyName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "matchedOn": { "type": "string", "enum": [ "code", "vatCode" ] } }, "required": [ "memberCompanyId", "memberName", "partnerId", "partnerName", "partnerCode", "matchesCompanyId", "matchesCompanyName", "matchedOn" ], "additionalProperties": false } } }, "required": [ "presentationCurrency", "fromDate", "toDate", "category", "statements", "trialBalance", "nonControllingInterest", "equityMethod", "members", "eliminations", "intercompanyCandidates" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/public/integration-requests": { "post": { "tags": [ "public" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "company": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "details": { "type": "string", "maxLength": 2000, "pattern": "^[\\s\\S]*$" }, "website": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "integration", "name", "email" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "received": { "type": "boolean" } }, "required": [ "received" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/login-link/request": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "locale": { "default": "lt", "type": "string", "enum": [ "lt", "en", "ru" ] } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/login-link/consume": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 10, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "token" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expiresAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "user": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "plan": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "email", "name", "plan" ], "additionalProperties": false }, "isNewUser": { "type": "boolean" } }, "required": [ "token", "expiresAt", "user", "isNewUser" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/logout": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "loggedOut": { "type": "boolean" } }, "required": [ "loggedOut" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/me": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "locale": { "type": "string", "pattern": "^[\\s\\S]*$" }, "plan": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isSuperAdmin": { "type": "boolean" } }, "required": [ "id", "email", "name", "locale", "plan", "isSuperAdmin" ], "additionalProperties": false }, "locale": { "type": "string", "pattern": "^[\\s\\S]*$" }, "activeCompanyId": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "role": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isSandbox": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived", "deleted" ] }, "deletedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "code", "vatCode", "role", "isSandbox", "status", "deletedAt" ], "additionalProperties": false } } }, "required": [ "user", "locale", "activeCompanyId", "role", "companies" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/members/list": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "userId", "email", "name", "role", "createdAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/members/set-role": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "enum": [ "admin", "accountant", "manager", "developer", "viewer" ] } }, "required": [ "userId", "role" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "userId", "role" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/members/remove": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "removed": { "type": "boolean" } }, "required": [ "removed" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/invites/create": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": [ "admin", "accountant", "manager", "developer", "viewer" ] }, "locale": { "default": "lt", "type": "string", "enum": [ "lt", "en", "ru" ] } }, "required": [ "email", "role" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expiresAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "inviteUrl": { "type": "string", "pattern": "^[\\s\\S]*$" }, "emailSent": { "type": "boolean" } }, "required": [ "id", "email", "role", "expiresAt", "inviteUrl", "emailSent" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/invites/list": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expiresAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expired": { "type": "boolean" } }, "required": [ "id", "email", "role", "expiresAt", "createdAt", "expired" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/invites/revoke": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/invites/get": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 10, "maxLength": 200, "pattern": "^[\\s\\S]*$" } }, "required": [ "token" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "pattern": "^[\\s\\S]*$" }, "companyName": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expired": { "type": "boolean" }, "userExists": { "type": "boolean" } }, "required": [ "email", "role", "companyName", "expired", "userExists" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/invites/accept": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 10, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "locale": { "default": "lt", "type": "string", "enum": [ "lt", "en", "ru" ] } }, "required": [ "token" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "pattern": "^[\\s\\S]*$" }, "expiresAt": { "type": "string", "pattern": "^[\\s\\S]*$" }, "user": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "email": { "type": "string", "pattern": "^[\\s\\S]*$" }, "name": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "plan": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "email", "name", "plan" ], "additionalProperties": false } }, "required": [ "token", "expiresAt", "user" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/locale/set": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "lt", "en", "ru" ] } }, "required": [ "locale" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "pattern": "^[\\s\\S]*$" }, "scope": { "type": "string", "enum": [ "membership", "user" ] } }, "required": [ "locale", "scope" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/companies/create": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "vatCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "smeExemptionNumber": { "type": "string", "maxLength": 30, "pattern": "^[\\s\\S]*$" }, "isVatPayer": { "type": "boolean" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "iban": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "bankName": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "peppolId": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "defaultInvoiceCurrency": { "type": "string", "pattern": "^[A-Za-z]{3}$" }, "countryCode": { "default": "LT", "description": "Jurisdiction the company is registered in (immutable after creation)", "type": "string", "enum": [ "AT", "BE", "BG", "CY", "CZ", "DE", "DK", "EE", "ES", "FI", "FR", "GR", "HR", "HU", "IE", "IT", "LT", "LU", "LV", "MT", "NL", "PL", "PT", "RO", "SE", "SI", "SK", "IS", "LI", "NO" ] }, "isSandbox": { "default": false, "description": "Sandbox companies hold test data and are purged immediately on delete (immutable after creation)", "type": "boolean" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "pattern": "^[\\s\\S]*$" }, "isSandbox": { "type": "boolean" } }, "required": [ "id", "name", "code", "vatCode", "role", "isSandbox" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/companies/select": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "companyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "companyId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "activeCompanyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "activeCompanyId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/companies/profile": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "smeExemptionNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isVatPayer": { "type": "boolean" }, "isSandbox": { "type": "boolean" }, "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "baseCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "defaultInvoiceCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "active", "archived", "deleted" ] }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "bankName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "peppolId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "logoFileId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "code", "vatCode", "smeExemptionNumber", "isVatPayer", "isSandbox", "countryCode", "baseCurrency", "defaultInvoiceCurrency", "status", "address", "email", "phone", "iban", "bankName", "peppolId", "logoFileId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/companies/update": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "code": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "vatCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "smeExemptionNumber": { "type": "string", "maxLength": 30, "pattern": "^[\\s\\S]*$" }, "isVatPayer": { "type": "boolean" }, "address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } } }, "email": { "type": "string", "maxLength": 200, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "iban": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "bankName": { "type": "string", "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "peppolId": { "type": "string", "maxLength": 50, "pattern": "^[\\s\\S]*$" }, "defaultInvoiceCurrency": { "type": "string", "pattern": "^[A-Za-z]{3}$" }, "logo": { "type": "object", "properties": { "fileName": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\s\\S]*$" }, "mimeType": { "type": "string", "minLength": 1, "maxLength": 150, "pattern": "^[\\s\\S]*$" }, "content": { "type": "string", "minLength": 1, "maxLength": 2000000, "description": "Base64-encoded image", "pattern": "^[\\s\\S]*$" } }, "required": [ "fileName", "mimeType", "content" ] } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "code": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "vatCode": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "smeExemptionNumber": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "isVatPayer": { "type": "boolean" }, "isSandbox": { "type": "boolean" }, "countryCode": { "type": "string", "pattern": "^[\\s\\S]*$" }, "baseCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "defaultInvoiceCurrency": { "type": "string", "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "enum": [ "active", "archived", "deleted" ] }, "address": { "nullable": true, "type": "object", "properties": { "street": { "type": "string", "maxLength": 300, "pattern": "^[\\s\\S]*$" }, "city": { "type": "string", "maxLength": 100, "pattern": "^[\\s\\S]*$" }, "postalCode": { "type": "string", "maxLength": 20, "pattern": "^[\\s\\S]*$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[\\s\\S]*$" } }, "additionalProperties": false }, "email": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "phone": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "iban": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "bankName": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "peppolId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "logoFileId": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "code", "vatCode", "smeExemptionNumber", "isVatPayer", "isSandbox", "countryCode", "baseCurrency", "defaultInvoiceCurrency", "status", "address", "email", "phone", "iban", "bankName", "peppolId", "logoFileId" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/companies/archive": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "companyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "companyId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "status" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/companies/delete": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "companyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "companyId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "pattern": "^[\\s\\S]*$" }, "purgeAfter": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "status", "purgeAfter" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/companies/activate": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "companyId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "companyId" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "status" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/api-keys/create": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\s\\S]*$" }, "scopes": { "default": [ "*" ], "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[\\s\\S]*$" } } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "scopes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "key": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "scopes", "key" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/api-keys/list": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "pattern": "^[\\s\\S]*$" }, "scopes": { "type": "array", "items": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "lastUsedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "revokedAt": { "nullable": true, "type": "string", "pattern": "^[\\s\\S]*$" }, "createdAt": { "type": "string", "pattern": "^[\\s\\S]*$" } }, "required": [ "id", "name", "scopes", "lastUsedAt", "revokedAt", "createdAt" ], "additionalProperties": false } } }, "required": [ "rows" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/account/api-keys/revoke": { "post": { "tags": [ "account" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\s\\S]*$" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "additionalProperties": false } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "400": { "description": "Request validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "404": { "description": "The requested resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "409": { "description": "The request conflicts with the current state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "422": { "description": "The request is well-formed but violates a business rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "X-RateLimit-Limit": { "description": "Request budget for the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "X-RateLimit-Reset": { "description": "Seconds until the window resets", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "servers": [ { "url": "https://api.nordlet.com", "description": "Production" } ], "security": [ { "apiKey": [] } ] }