{ "openapi": "3.0.4", "info": { "title": "Panoptes API", "version": "v1", "description": "The Panoptes restaurant operating system API. Console routes (/api/v1/console/**) accept a console JWT or an X-Api-Key holding the matching cap: scope; the public partner API lives under /api/v1/public/**. Generated from the live backend Swagger document — controller code is the source of truth." }, "servers": [ { "url": "https://api.panoptesos.com", "description": "Production" }, { "url": "https://staging-api.panoptesos.com", "description": "Staging" } ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "paths": { "/api/v1/console/accounting/journal/export": { "get": { "tags": [ "AccountingExports" ], "parameters": [ { "name": "Date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/accounts/export": { "get": { "tags": [ "AccountingExports" ], "parameters": [ { "name": "Format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/accounts": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAccountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/accounts/{id}": { "get": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAccountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/accounts/seed": { "post": { "tags": [ "Accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeedChartRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeedChartRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SeedChartRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/accounts/{id}/active": { "post": { "tags": [ "Accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAccountActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetAccountActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetAccountActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/advances": { "get": { "tags": [ "Advances" ], "parameters": [ { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Advances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAdvanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAdvanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAdvanceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/advances/{id}/decision": { "post": { "tags": [ "Advances" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAdvanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecideAdvanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecideAdvanceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/loans": { "get": { "tags": [ "Advances" ], "parameters": [ { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Advances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLoanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLoanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLoanRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/loans/{id}/decision": { "post": { "tags": [ "Advances" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideLoanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecideLoanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecideLoanRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/aging/payables": { "get": { "tags": [ "Aging" ], "parameters": [ { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/aging/receivables": { "get": { "tags": [ "Aging" ], "parameters": [ { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/announcements": { "get": { "tags": [ "Announcements" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/developers/api-keys": { "get": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "IncludeRevoked", "in": "query", "schema": { "type": "boolean" } }, { "name": "Environment", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] }, "post": { "tags": [ "ApiKeys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/api-keys/scopes": { "get": { "tags": [ "ApiKeys" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/api-keys/{id}": { "get": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/api-keys/{id}/rotate": { "post": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RotateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RotateApiKeyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/api-keys/{id}/revoke": { "post": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeApiKeyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/fraud/approval-requests": { "get": { "tags": [ "ApprovalRequests" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "MineOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ApprovalRequests" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApprovalRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateApprovalRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateApprovalRequestRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/approval-requests/{id}": { "get": { "tags": [ "ApprovalRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/approval-requests/{id}/approve": { "post": { "tags": [ "ApprovalRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideApprovalRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecideApprovalRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecideApprovalRequestRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/approval-requests/{id}/reject": { "post": { "tags": [ "ApprovalRequests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideApprovalRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecideApprovalRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecideApprovalRequestRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/attendance": { "get": { "tags": [ "Attendance" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Attendance" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordAttendanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordAttendanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordAttendanceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/attendance/clock": { "post": { "tags": [ "Attendance" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClockRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClockRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClockRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/chain": { "get": { "tags": [ "AuditChain" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/chain/verify": { "post": { "tags": [ "AuditChain" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/chain/verifications": { "get": { "tags": [ "AuditChain" ], "parameters": [ { "name": "Scope", "in": "query", "schema": { "type": "string" } }, { "name": "Ok", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/chain/proof": { "get": { "tags": [ "AuditChain" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/logs": { "get": { "tags": [ "AuditLogs" ], "parameters": [ { "name": "Action", "in": "query", "schema": { "type": "string" } }, { "name": "EntityType", "in": "query", "schema": { "type": "string" } }, { "name": "EntityId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "UserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "FromSeq", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ToSeq", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/logs/{id}": { "get": { "tags": [ "AuditLogs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/logs/entities/{entityType}/{entityId}": { "get": { "tags": [ "AuditLogs" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Field", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/auth/login": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/refresh": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/activate": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivateAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivateAccountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/register/start": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterStartRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterStartRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterStartRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/register/verify": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterVerifyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterVerifyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterVerifyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/verification/resend": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendVerificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResendVerificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResendVerificationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/password/forgot": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/password/reset": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/me": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/switch-branch": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchBranchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SwitchBranchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SwitchBranchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/change-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/change-email/start": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartEmailChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StartEmailChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StartEmailChangeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/change-email/verify": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyEmailChangeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/change-email/resend": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendEmailChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResendEmailChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResendEmailChangeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/change-email/cancel": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelEmailChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelEmailChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelEmailChangeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/auth/logout": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/accounting/bank-accounts": { "get": { "tags": [ "Bank" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Bank" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBankAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBankAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBankAccountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/bank-accounts/{id}": { "get": { "tags": [ "Bank" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/bank-accounts/{id}/statement-imports": { "post": { "tags": [ "Bank" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportBankStatementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportBankStatementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportBankStatementRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/bank-statement-lines": { "get": { "tags": [ "Bank" ], "parameters": [ { "name": "BankAccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/bank-statement-lines/{id}/suggestions": { "get": { "tags": [ "Bank" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/bank-statement-lines/{id}/match": { "post": { "tags": [ "Bank" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchBankLineRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchBankLineRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MatchBankLineRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/bank-statement-lines/{id}/exclude": { "post": { "tags": [ "Bank" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExcludeBankLineRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExcludeBankLineRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExcludeBankLineRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/bank-statement-lines/{id}/reopen": { "post": { "tags": [ "Bank" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenBankLineRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReopenBankLineRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReopenBankLineRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches/{id}/waste": { "post": { "tags": [ "BatchCapacity" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordBatchWasteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordBatchWasteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordBatchWasteRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches/{id}/outputs": { "post": { "tags": [ "BatchCapacity" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordProductionOutputRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordProductionOutputRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordProductionOutputRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches/{id}/outputs/{outputId}": { "delete": { "tags": [ "BatchCapacity" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "outputId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReverseProductionOutputRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReverseProductionOutputRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReverseProductionOutputRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batch-templates": { "get": { "tags": [ "BatchTemplates" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "BatchTemplates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatchTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBatchTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBatchTemplateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batch-templates/{id}": { "delete": { "tags": [ "BatchTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireBatchTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireBatchTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireBatchTemplateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/branches": { "get": { "tags": [ "Branches" ], "parameters": [ { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Branches" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBranchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBranchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBranchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/branches/{id}": { "get": { "tags": [ "Branches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Branches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBranchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBranchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBranchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Branches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteBranchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteBranchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteBranchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/branch-groups": { "get": { "tags": [ "BranchGroups" ], "parameters": [ { "name": "Kind", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "BranchGroups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBranchGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBranchGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBranchGroupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/branch-groups/{id}": { "put": { "tags": [ "BranchGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBranchGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBranchGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBranchGroupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "BranchGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireBranchGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireBranchGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireBranchGroupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/branch-groups/{id}/branches": { "post": { "tags": [ "BranchGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddBranchToGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddBranchToGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddBranchToGroupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/branch-groups/{id}/branches/{branchId}": { "delete": { "tags": [ "BranchGroups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "branchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBranchFromGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveBranchFromGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveBranchFromGroupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users/{userId}/memberships": { "get": { "tags": [ "BranchMemberships" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include_revoked", "in": "query", "schema": { "type": "boolean" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "BranchMemberships" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantBranchMembershipRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrantBranchMembershipRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GrantBranchMembershipRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users/{userId}/memberships/{branchId}": { "delete": { "tags": [ "BranchMemberships" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "branchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeBranchMembershipRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeBranchMembershipRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeBranchMembershipRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users/{userId}/org-admin": { "patch": { "tags": [ "BranchMemberships" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetOrgAdminRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetOrgAdminRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetOrgAdminRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/brands": { "get": { "tags": [ "Brands" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Brands" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBrandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBrandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBrandRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/brands/{id}": { "get": { "tags": [ "Brands" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "Brands" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBrandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBrandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBrandRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Brands" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireBrandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireBrandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireBrandRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/brands/{id}/active": { "post": { "tags": [ "Brands" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBrandActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetBrandActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetBrandActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channels/{channelId}/product-map": { "get": { "tags": [ "ChannelProductMap" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ProductId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ChannelProductMap" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChannelProductMapRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateChannelProductMapRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateChannelProductMapRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channels/{channelId}/product-map/{mapId}": { "delete": { "tags": [ "ChannelProductMap" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mapId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteChannelProductMapRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteChannelProductMapRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteChannelProductMapRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/receivables/aging": { "get": { "tags": [ "ChannelReceivables" ], "parameters": [ { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channels": { "get": { "tags": [ "Channels" ], "parameters": [ { "name": "TypeCode", "in": "query", "schema": { "type": "string" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channels/{channelId}/rules": { "get": { "tags": [ "Channels" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channels/rules": { "post": { "tags": [ "Channels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommissionRuleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCommissionRuleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCommissionRuleRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channels/rules/{ruleId}/active": { "patch": { "tags": [ "Channels" ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCommissionRuleActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetCommissionRuleActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetCommissionRuleActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channels/rule-requests": { "post": { "tags": [ "Channels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommissionRuleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCommissionRuleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCommissionRuleRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/attendance/sessions": { "post": { "tags": [ "CheckIn" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueCheckInSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCheckInSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueCheckInSessionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/attendance/evidence": { "post": { "tags": [ "CheckIn" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitCheckInEvidenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitCheckInEvidenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitCheckInEvidenceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "get": { "tags": [ "CheckIn" ], "parameters": [ { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Dispute", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/attendance/evidence/{id}/decision": { "post": { "tags": [ "CheckIn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideCheckInEvidenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecideCheckInEvidenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecideCheckInEvidenceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/attendance/evidence/{id}/dispute": { "post": { "tags": [ "CheckIn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetEvidenceDisputeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetEvidenceDisputeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetEvidenceDisputeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/combos": { "get": { "tags": [ "Combos" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Combos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateComboRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateComboRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateComboRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/combos/{id}": { "get": { "tags": [ "Combos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Combos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateComboRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateComboRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateComboRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Combos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteComboRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteComboRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteComboRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/developers/connectors": { "get": { "tags": [ "Connectors" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/connectors/{connectorId}/connect": { "post": { "tags": [ "Connectors" ], "parameters": [ { "name": "connectorId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectConnectorRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectConnectorRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConnectConnectorRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/products/{productId}/consumables": { "get": { "tags": [ "ConsumableBom" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ConsumableBom" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddProductConsumableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddProductConsumableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddProductConsumableRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products/{productId}/consumables/{bomLineId}": { "delete": { "tags": [ "ConsumableBom" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "bomLineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/costing/orders": { "get": { "tags": [ "CostCards" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "IncompleteOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeTerminal", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/costing/orders/{orderId}": { "get": { "tags": [ "CostCards" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/costing/cost-per-serving": { "get": { "tags": [ "CostCards" ], "parameters": [ { "name": "Channel", "in": "query", "schema": { "type": "string" } }, { "name": "IncompleteOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeInactive", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/costing/recalculate": { "post": { "tags": [ "CostRecalculation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecalculateProductCostsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecalculateProductCostsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecalculateProductCostsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/costing/recalculate/products/{productId}": { "post": { "tags": [ "CostRecalculation" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reason", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/movements/count-corrections": { "post": { "tags": [ "CountCorrections" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyCountCorrectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyCountCorrectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyCountCorrectionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/currencies": { "get": { "tags": [ "Currencies" ], "parameters": [ { "name": "IncludeInactive", "in": "query", "schema": { "type": "boolean" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices": { "get": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ToExclusive", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "OutstandingOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "CustomerInvoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/{id}": { "get": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCustomerInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteCustomerInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteCustomerInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/{id}/issue": { "post": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueCustomerInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCustomerInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueCustomerInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/{id}/payments": { "post": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCustomerInvoicePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordCustomerInvoicePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordCustomerInvoicePaymentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/{id}/void": { "post": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoidCustomerInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoidCustomerInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VoidCustomerInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/billable-orders": { "get": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/statement": { "get": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "Customer", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/statement/pdf": { "get": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "Customer", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/customer-invoices/{id}/pdf": { "get": { "tags": [ "CustomerInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Lang", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/dashboard/tiles": { "get": { "tags": [ "Dashboards" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/dashboard/layout": { "get": { "tags": [ "Dashboards" ], "parameters": [ { "name": "Preset", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveDashboardLayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveDashboardLayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveDashboardLayoutRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetDashboardLayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetDashboardLayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetDashboardLayoutRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/dashboard/export": { "get": { "tags": [ "Dashboards" ], "parameters": [ { "name": "Format", "in": "query", "schema": { "type": "string" } }, { "name": "Preset", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/policies": { "get": { "tags": [ "DeliveryPolicies" ], "parameters": [ { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "DeliveryPolicies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertDeliveryPolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertDeliveryPolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertDeliveryPolicyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/policies/{channelId}": { "get": { "tags": [ "DeliveryPolicies" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/reviews/returnable-orders": { "get": { "tags": [ "DeliveryReviews" ], "parameters": [ { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/reviews/compliance": { "get": { "tags": [ "DeliveryReviews" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/reviews": { "post": { "tags": [ "DeliveryReviews" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitDeliveryReviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitDeliveryReviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitDeliveryReviewRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/reviews/missed": { "post": { "tags": [ "DeliveryReviews" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/settlements": { "get": { "tags": [ "DeliverySettlements" ], "parameters": [ { "name": "ChannelId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/settlements/{id}": { "get": { "tags": [ "DeliverySettlements" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/settlements/import": { "post": { "tags": [ "DeliverySettlements" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportSettlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportSettlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportSettlementRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/settlements/{id}/reconcile": { "post": { "tags": [ "DeliverySettlements" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/settlements/transfers": { "post": { "tags": [ "DeliverySettlements" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordDeliverySettlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordDeliverySettlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordDeliverySettlementRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/settlements/variance": { "get": { "tags": [ "DeliverySettlements" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/dining-areas": { "get": { "tags": [ "DiningAreas" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "DiningAreas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDiningAreaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDiningAreaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDiningAreaRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/dining-areas/{id}": { "put": { "tags": [ "DiningAreas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDiningAreaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDiningAreaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDiningAreaRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "DiningAreas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDiningAreaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteDiningAreaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteDiningAreaRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/dining-tables": { "get": { "tags": [ "DiningTables" ], "parameters": [ { "name": "AreaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "DiningTables" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDiningTableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDiningTableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDiningTableRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/dining-tables/{id}": { "put": { "tags": [ "DiningTables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDiningTableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDiningTableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDiningTableRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "DiningTables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDiningTableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteDiningTableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteDiningTableRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/dining-tables/{id}/active": { "post": { "tags": [ "DiningTables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDiningTableActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetDiningTableActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetDiningTableActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/dining-tables/{id}/qr-token": { "post": { "tags": [ "DiningTables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "DiningTables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/employees/{id}/documents": { "get": { "tags": [ "EmployeeDocuments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeRetired", "in": "query", "schema": { "type": "boolean" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "EmployeeDocuments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEmployeeDocumentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddEmployeeDocumentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddEmployeeDocumentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/employees/documents/{documentId}": { "delete": { "tags": [ "EmployeeDocuments" ], "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireEmployeeDocumentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireEmployeeDocumentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireEmployeeDocumentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/employees": { "get": { "tags": [ "Employees" ], "parameters": [ { "name": "DepartmentId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "PositionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "EmploymentStatus", "in": "query", "schema": { "$ref": "#/components/schemas/EmploymentStatus" } }, { "name": "IncludeRetired", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Employees" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmployeeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateEmployeeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateEmployeeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/employees/{id}": { "get": { "tags": [ "Employees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Employees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmployeeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEmployeeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEmployeeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Employees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireEmployeeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireEmployeeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireEmployeeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/employees/{id}/employment-status": { "post": { "tags": [ "Employees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetEmploymentStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetEmploymentStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetEmploymentStatusRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/departments": { "get": { "tags": [ "Employees" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "OrgUnits" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDepartmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDepartmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDepartmentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/positions": { "get": { "tags": [ "Employees" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "OrgUnits" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePositionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/eod-reports": { "get": { "tags": [ "EodReports" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "EodReports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveEodReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveEodReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveEodReportRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/eod-reports/{id}": { "get": { "tags": [ "EodReports" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "EodReports" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEodReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateEodReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateEodReportRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/eod-reports/parse": { "post": { "tags": [ "EodReports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParseEodTextRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ParseEodTextRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ParseEodTextRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/exchange-rates": { "get": { "tags": [ "ExchangeRates" ], "parameters": [ { "name": "FromCurrencyCode", "in": "query", "schema": { "type": "string" } }, { "name": "ToCurrencyCode", "in": "query", "schema": { "type": "string" } }, { "name": "RateType", "in": "query", "schema": { "$ref": "#/components/schemas/ExchangeRateType" } }, { "name": "InForceOnly", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ExchangeRates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordExchangeRateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordExchangeRateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordExchangeRateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/export-jobs": { "get": { "tags": [ "ExportJobs" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ExportJobs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExportJobRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateExportJobRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateExportJobRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/export-jobs/{id}": { "get": { "tags": [ "ExportJobs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ExportJobs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/export-jobs/{id}/download": { "get": { "tags": [ "ExportJobs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/export-presets": { "get": { "tags": [ "ExportPresets" ], "parameters": [ { "name": "Domain", "in": "query", "schema": { "type": "string" } }, { "name": "ImportCompatible", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ExportPresets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveExportPresetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveExportPresetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveExportPresetRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/export-presets/domains": { "get": { "tags": [ "ExportPresets" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/export-presets/{id}": { "delete": { "tags": [ "ExportPresets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireExportPresetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireExportPresetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireExportPresetRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/floor": { "get": { "tags": [ "Floor" ], "parameters": [ { "name": "AreaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/table": { "post": { "tags": [ "FloorSeating" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveOrderTableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveOrderTableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveOrderTableRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/release": { "post": { "tags": [ "FloorSeating" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/franchisees": { "get": { "tags": [ "Franchisees" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Franchisees" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFranchiseeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFranchiseeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFranchiseeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/franchisees/{id}": { "put": { "tags": [ "Franchisees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFranchiseeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFranchiseeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFranchiseeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/franchisees/{id}/royalty-statement": { "get": { "tags": [ "Franchisees" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/branches/{branchId}/franchisee": { "patch": { "tags": [ "Franchisees" ], "parameters": [ { "name": "branchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignBranchFranchiseeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignBranchFranchiseeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignBranchFranchiseeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/cases": { "get": { "tags": [ "FraudCases" ], "parameters": [ { "name": "Category", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/cases/summary": { "get": { "tags": [ "FraudCases" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/cases/{id}": { "get": { "tags": [ "FraudCases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "FraudCases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TombstoneFraudCaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TombstoneFraudCaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TombstoneFraudCaseRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/cases/{id}/status": { "patch": { "tags": [ "FraudCases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveFraudCaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveFraudCaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveFraudCaseRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/guest-payments": { "get": { "tags": [ "GuestPayments" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/guest-payments/{id}/confirm": { "post": { "tags": [ "GuestPayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmGuestPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfirmGuestPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConfirmGuestPaymentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/guest-payments/{id}/reject": { "post": { "tags": [ "GuestPayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectGuestPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RejectGuestPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RejectGuestPaymentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hq/today": { "get": { "tags": [ "Hq" ], "parameters": [ { "name": "BranchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hq/branches": { "get": { "tags": [ "Hq" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hq/consolidated-pnl": { "get": { "tags": [ "Hq" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/summary": { "get": { "tags": [ "HrDashboard" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/employees/{id}/profile": { "get": { "tags": [ "HrDashboard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/notifications": { "get": { "tags": [ "HrNotifications" ], "parameters": [ { "name": "Unread", "in": "query", "schema": { "type": "boolean" } }, { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/notifications/rebuild": { "post": { "tags": [ "HrNotifications" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/notifications/{id}/read": { "post": { "tags": [ "HrNotifications" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/notifications/read-all": { "post": { "tags": [ "HrNotifications" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/platform/idempotency-keys": { "get": { "tags": [ "IdempotencyKeys" ], "parameters": [ { "name": "Scope", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "StuckOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/platform/idempotency-keys/{id}/release": { "post": { "tags": [ "IdempotencyKeys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseIdempotencyKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseIdempotencyKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReleaseIdempotencyKeyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/platform/idempotency-keys/sweep": { "post": { "tags": [ "IdempotencyKeys" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/alerts": { "get": { "tags": [ "IntegrityAlerts" ], "parameters": [ { "name": "Acknowledged", "in": "query", "schema": { "type": "boolean" } }, { "name": "Kind", "in": "query", "schema": { "type": "string" } }, { "name": "Severity", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/audit/alerts/{id}/acknowledge": { "post": { "tags": [ "IntegrityAlerts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/counts/sheet": { "get": { "tags": [ "InventoryCounts" ], "parameters": [ { "name": "Book", "in": "query", "schema": { "$ref": "#/components/schemas/StockBook" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/counts": { "get": { "tags": [ "InventoryCounts" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Shift", "in": "query", "schema": { "$ref": "#/components/schemas/OperatingShift" } }, { "name": "Book", "in": "query", "schema": { "$ref": "#/components/schemas/StockBook" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "InventoryCounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitCountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/counts/{id}": { "get": { "tags": [ "InventoryCounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/counts/{id}/approve": { "post": { "tags": [ "InventoryCounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApproveCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApproveCountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/counts/{countId}/lines/{lineId}/approve": { "post": { "tags": [ "InventoryCounts" ], "parameters": [ { "name": "countId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveCountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApproveCountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApproveCountRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/counts/{countId}/lines/{lineId}/evidence": { "post": { "tags": [ "InventoryCounts" ], "parameters": [ { "name": "countId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureCountEvidenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaptureCountEvidenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaptureCountEvidenceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/counts/evidence/{evidenceId}": { "get": { "tags": [ "InventoryCounts" ], "parameters": [ { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/items": { "get": { "tags": [ "InventoryItems" ], "parameters": [ { "name": "Category", "in": "query", "schema": { "type": "string" } }, { "name": "ValuationMethod", "in": "query", "schema": { "type": "string" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "ProductionEligible", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "InventoryItems" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInventoryItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInventoryItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInventoryItemRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/items/{id}": { "get": { "tags": [ "InventoryItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "InventoryItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryItemRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "InventoryItems" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteInventoryItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteInventoryItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteInventoryItemRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/items/lookup": { "get": { "tags": [ "InventoryItems" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/journal/entries": { "get": { "tags": [ "Journal" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ToExclusive", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "AccountCode", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/journal/entries/{id}": { "get": { "tags": [ "Journal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/journal/daily-sales": { "post": { "tags": [ "Journal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostDailySalesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostDailySalesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostDailySalesRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/kds/board": { "get": { "tags": [ "KdsBoard" ], "parameters": [ { "name": "StationId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/kds/tickets/{ticketId}/transition": { "post": { "tags": [ "KdsBoard" ], "parameters": [ { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionKdsTicketRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransitionKdsTicketRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransitionKdsTicketRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/kds/stations": { "get": { "tags": [ "KdsStations" ], "parameters": [ { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "KdsStations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKdsStationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateKdsStationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateKdsStationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/kds/stations/{id}": { "put": { "tags": [ "KdsStations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateKdsStationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateKdsStationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateKdsStationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "KdsStations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteKdsStationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteKdsStationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteKdsStationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/kitchen-transfers": { "get": { "tags": [ "KitchenTransfers" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "InventoryItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "KitchenTransfers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestKitchenTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestKitchenTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestKitchenTransferRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/kitchen-transfers/{id}/approve": { "post": { "tags": [ "KitchenTransfers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/kitchen-transfers/{id}/reject": { "post": { "tags": [ "KitchenTransfers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectKitchenTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RejectKitchenTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RejectKitchenTransferRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/leave": { "get": { "tags": [ "Leave" ], "parameters": [ { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Leave" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLeaveRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLeaveRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLeaveRequestRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/leave/{id}/decision": { "post": { "tags": [ "Leave" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideLeaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecideLeaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecideLeaveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/days/lock": { "post": { "tags": [ "LedgerLock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LockBusinessDayRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LockBusinessDayRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LockBusinessDayRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/periods/close": { "post": { "tags": [ "LedgerLock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LossControlClosePeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LossControlClosePeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LossControlClosePeriodRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/periods/lock": { "post": { "tags": [ "LedgerLock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LossControlLockPeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LossControlLockPeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LossControlLockPeriodRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/periods/reopen": { "post": { "tags": [ "LedgerLock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LossControlReopenPeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LossControlReopenPeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LossControlReopenPeriodRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/legal-entities": { "get": { "tags": [ "LegalEntities" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "LegalEntities" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLegalEntityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLegalEntityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLegalEntityRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/legal-entities/{id}": { "get": { "tags": [ "LegalEntities" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "LegalEntities" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLegalEntityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLegalEntityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLegalEntityRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "LegalEntities" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireLegalEntityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireLegalEntityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireLegalEntityRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/staff-meals": { "get": { "tags": [ "LossCapture" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Location", "in": "query", "schema": { "$ref": "#/components/schemas/StockBook" } }, { "name": "InventoryItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "LossCapture" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordStaffMealRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordStaffMealRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordStaffMealRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/portion-checks": { "get": { "tags": [ "LossCapture" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ProductId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "InventoryItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "LossCapture" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordPortionCheckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordPortionCheckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordPortionCheckRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/summary": { "get": { "tags": [ "LossSummary" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "GroupBy", "in": "query", "schema": { "$ref": "#/components/schemas/LossSummaryGrouping" } }, { "name": "Shift", "in": "query", "schema": { "$ref": "#/components/schemas/LedgerShift" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/slice": { "get": { "tags": [ "LossSummary" ], "parameters": [ { "name": "BusinessDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Shift", "in": "query", "schema": { "$ref": "#/components/schemas/LedgerShift" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/breakdown": { "get": { "tags": [ "LossSummary" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/completeness": { "get": { "tags": [ "LossSummary" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/media/images": { "post": { "tags": [ "MediaImages" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/media/images/{assetId}": { "get": { "tags": [ "MediaImages" ], "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "MediaImages" ], "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reason", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/media/images/refresh-urls": { "post": { "tags": [ "MediaImages" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshImageUrlsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshImageUrlsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefreshImageUrlsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/media/owners/images/batch": { "post": { "tags": [ "MediaImages" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerImagesBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OwnerImagesBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OwnerImagesBatchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/media/owners/{ownerType}/{ownerId}/images": { "get": { "tags": [ "MediaImages" ], "parameters": [ { "name": "ownerType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/media/owners/{ownerType}/{ownerId}/images/gallery/order": { "put": { "tags": [ "MediaImages" ], "parameters": [ { "name": "ownerType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderGalleryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderGalleryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderGalleryRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/media/owners/{ownerType}/{ownerId}/images/{slot}": { "put": { "tags": [ "MediaImages" ], "parameters": [ { "name": "ownerType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachImageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttachImageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AttachImageRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "MediaImages" ], "parameters": [ { "name": "ownerType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "slot", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/modifiers/groups": { "get": { "tags": [ "Modifiers" ], "parameters": [ { "name": "ProductId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Modifiers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModifierGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateModifierGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateModifierGroupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/modifiers/groups/{id}": { "get": { "tags": [ "Modifiers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Modifiers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireModifierGroupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireModifierGroupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireModifierGroupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/modifiers/options": { "post": { "tags": [ "Modifiers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModifierOptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateModifierOptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateModifierOptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/modifiers/options/{id}": { "delete": { "tags": [ "Modifiers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireModifierOptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireModifierOptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireModifierOptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/modifiers/validate-selection": { "post": { "tags": [ "Modifiers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateModifierSelectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateModifierSelectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateModifierSelectionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/payment-methods": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/payment-methods/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/payment-methods/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/revoke-reasons": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/revoke-reasons/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/revoke-reasons/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/units": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/units/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/units/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/variance-reasons": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/variance-reasons/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/variance-reasons/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/leave-types": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/leave-types/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/leave-types/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/document-types": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/document-types/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/document-types/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/violation-types": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/violation-types/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/violation-types/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/capacity-types": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/capacity-types/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/capacity-types/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channel-types": { "get": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ModuleVocabularies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channel-types/{id}": { "put": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/delivery/channel-types/{id}/active": { "post": { "tags": [ "ModuleVocabularies" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/public/oauth/authorize": { "get": { "tags": [ "OAuth" ], "parameters": [ { "name": "ClientId", "in": "query", "schema": { "type": "string" } }, { "name": "RedirectUri", "in": "query", "schema": { "type": "string" } }, { "name": "ResponseType", "in": "query", "schema": { "type": "string" } }, { "name": "Scope", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "CodeChallenge", "in": "query", "schema": { "type": "string" } }, { "name": "CodeChallengeMethod", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [] } }, "/api/v1/public/oauth/register": { "post": { "tags": [ "OAuth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthRegisterClientRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [] } }, "/api/v1/public/oauth/token": { "post": { "tags": [ "OAuth" ], "responses": { "200": { "description": "Success" } }, "security": [] } }, "/api/v1/console/developers/oauth-clients": { "get": { "tags": [ "OAuthClients" ], "parameters": [ { "name": "IncludeRevoked", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] }, "post": { "tags": [ "OAuthClients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterOAuthClientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterOAuthClientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterOAuthClientRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/oauth-clients/{id}/revoke": { "post": { "tags": [ "OAuthClients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeOAuthClientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeOAuthClientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeOAuthClientRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/oauth/consent": { "post": { "tags": [ "OAuthClients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthConsentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthConsentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthConsentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/online-menu": { "get": { "tags": [ "OnlineMenu" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/online-menu/slug": { "put": { "tags": [ "OnlineMenu" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePublicSlugRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePublicSlugRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePublicSlugRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/online-menu/slug/availability": { "get": { "tags": [ "OnlineMenu" ], "parameters": [ { "name": "slug", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/online-menu/enabled": { "put": { "tags": [ "OnlineMenu" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPublicMenuEnabledRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPublicMenuEnabledRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetPublicMenuEnabledRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/online-menu/domain": { "put": { "tags": [ "OnlineMenu" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCustomDomainRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetCustomDomainRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetCustomDomainRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "OnlineMenu" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/online-menu/domain/verify": { "post": { "tags": [ "OnlineMenu" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/courses/{courseNumber}/fire": { "post": { "tags": [ "OrderCourses" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "courseNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "ChannelId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "CashierId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "DiningTableId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSaleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSaleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSaleRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/status": { "patch": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrderStatusRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/cancel": { "post": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{orderId}/lines/{lineId}/void": { "post": { "tags": [ "Orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoidLineRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoidLineRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VoidLineRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{orderId}/lines/{lineId}/comp": { "post": { "tags": [ "Orders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompLineRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompLineRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompLineRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/refund": { "post": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefundOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefundOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/organizations": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/organizations/{id}": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireOrganizationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/organizations/{id}/branches": { "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdoptBranchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdoptBranchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdoptBranchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/departments/{id}": { "put": { "tags": [ "OrgUnits" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDepartmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDepartmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDepartmentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "OrgUnits" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireOrgUnitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireOrgUnitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireOrgUnitRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/positions/{id}": { "put": { "tags": [ "OrgUnits" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePositionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "OrgUnits" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireOrgUnitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireOrgUnitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireOrgUnitRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/platform/outbox": { "get": { "tags": [ "Outbox" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "AggregateType", "in": "query", "schema": { "type": "string" } }, { "name": "EventType", "in": "query", "schema": { "type": "string" } }, { "name": "AggregateId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/platform/outbox/{id}": { "get": { "tags": [ "Outbox" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/platform/outbox/{id}/replay": { "post": { "tags": [ "Outbox" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplayOutboxMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReplayOutboxMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReplayOutboxMessageRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/payroll": { "get": { "tags": [ "Payroll" ], "parameters": [ { "name": "Year", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Payroll" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePayrollRunRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeneratePayrollRunRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GeneratePayrollRunRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/payroll/{id}": { "get": { "tags": [ "Payroll" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/payroll/payslips/{payslipId}": { "put": { "tags": [ "Payroll" ], "parameters": [ { "name": "payslipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePayslipRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePayslipRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePayslipRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/payroll/{id}/approve": { "post": { "tags": [ "Payroll" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/payroll/{id}/pay": { "post": { "tags": [ "Payroll" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/performance-reviews": { "get": { "tags": [ "PerformanceReviews" ], "parameters": [ { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "PeriodLabel", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "PerformanceReviews" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePerformanceReviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePerformanceReviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePerformanceReviewRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/periods": { "get": { "tags": [ "Periods" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/periods/{id}": { "get": { "tags": [ "Periods" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Periods" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeletePeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeletePeriodRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/periods/close": { "post": { "tags": [ "Periods" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingClosePeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountingClosePeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountingClosePeriodRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/periods/lock": { "post": { "tags": [ "Periods" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingLockPeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountingLockPeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountingLockPeriodRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/periods/reopen": { "post": { "tags": [ "Periods" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingReopenPeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountingReopenPeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountingReopenPeriodRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/pilots": { "get": { "tags": [ "Pilots" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Pilots" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePilotRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePilotRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePilotRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/pilots/{id}": { "get": { "tags": [ "Pilots" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Pilots" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePilotRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePilotRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePilotRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Pilots" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePilotRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeletePilotRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeletePilotRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/loss/pilots/{id}/status": { "post": { "tags": [ "Pilots" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPilotStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPilotStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetPilotStatusRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/reference": { "get": { "tags": [ "PosReference" ], "parameters": [ { "name": "KnownVersion", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pricing/preview": { "post": { "tags": [ "PricePreview" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricePreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PricePreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PricePreviewRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pricing/live-promotions": { "get": { "tags": [ "PricePreview" ], "parameters": [ { "name": "ChannelId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "GrossTotal", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices/price-variance": { "get": { "tags": [ "PriceVariance" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "SupplierId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ThresholdPct", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "TopN", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/reports/price-variance": { "get": { "tags": [ "PriceVariance" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "SupplierId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ThresholdPct", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "TopN", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices/price-history": { "get": { "tags": [ "PriceVariance" ], "parameters": [ { "name": "InventoryItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "SupplierId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices/loss-slices": { "get": { "tags": [ "PriceVariance" ], "parameters": [ { "name": "BusinessDate", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/product-categories": { "get": { "tags": [ "ProductCategories" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ProductCategories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProductCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProductCategoryRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/product-categories/{id}": { "get": { "tags": [ "ProductCategories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "ProductCategories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProductCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProductCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProductCategoryRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ProductCategories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireProductCategoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireProductCategoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireProductCategoryRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/catalog/imports/products": { "post": { "tags": [ "ProductImport" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductImportDryRunRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductImportDryRunRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductImportDryRunRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/catalog/imports/{batchId}": { "get": { "tags": [ "ProductImport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/catalog/imports/{batchId}/commit": { "post": { "tags": [ "ProductImport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitProductImportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommitProductImportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommitProductImportRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches": { "get": { "tags": [ "ProductionBatches" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ProductionBatches" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductionBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProductionBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProductionBatchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches/{id}": { "get": { "tags": [ "ProductionBatches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "OutputSort", "in": "query", "schema": { "type": "string" } }, { "name": "OutputDir", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } }, { "name": "output_sort", "in": "query", "schema": { "type": "string" } }, { "name": "output_dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "ProductionBatches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProductionBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProductionBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProductionBatchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ProductionBatches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireProductionBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireProductionBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireProductionBatchRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches/{id}/status": { "put": { "tags": [ "ProductionBatches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProductionBatchStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetProductionBatchStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetProductionBatchStatusRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches/{id}/overflow": { "put": { "tags": [ "ProductionBatches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProductionBatchOverflowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetProductionBatchOverflowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetProductionBatchOverflowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/production/batches/{id}/close": { "post": { "tags": [ "ProductionBatches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products": { "get": { "tags": [ "Products" ], "parameters": [ { "name": "CategoryId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Is86", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Products" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProductRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products/{id}": { "get": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireProductRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireProductRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products/{id}/price": { "patch": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProductPriceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProductPriceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProductPriceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products/{id}/availability": { "patch": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProductAvailabilityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetProductAvailabilityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetProductAvailabilityRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products/{id}/recipe": { "get": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products/{id}/recipe/ingredients": { "post": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddRecipeIngredientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddRecipeIngredientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddRecipeIngredientRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/products/{id}/recipe/ingredients/{bomLineId}": { "delete": { "tags": [ "Products" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "bomLineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/promotions": { "get": { "tags": [ "Promotions" ], "parameters": [ { "name": "ChannelId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeAllChannel", "in": "query", "schema": { "type": "boolean" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Promotions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromotionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePromotionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePromotionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/promotions/{id}": { "get": { "tags": [ "Promotions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Promotions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetirePromotionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetirePromotionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetirePromotionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/promotions/{id}/active": { "patch": { "tags": [ "Promotions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPromotionActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPromotionActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetPromotionActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/promotions/change-requests": { "post": { "tags": [ "Promotions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromotionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePromotionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePromotionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/public/items": { "get": { "tags": [ "PublicCatalog" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Is86", "in": "query", "schema": { "type": "boolean" } }, { "name": "ExternalId", "in": "query", "schema": { "type": "string" } }, { "name": "Category", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/public/modifiers": { "get": { "tags": [ "PublicCatalog" ], "parameters": [ { "name": "ProductId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/public/categories": { "get": { "tags": [ "PublicCatalog" ], "parameters": [ { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/public/inventory": { "get": { "tags": [ "PublicInventory" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Category", "in": "query", "schema": { "type": "string" } }, { "name": "ExternalId", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/public/suppliers": { "get": { "tags": [ "PublicInventory" ], "parameters": [ { "name": "ExternalId", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/guest/menu/{identifier}": { "get": { "tags": [ "PublicMenu" ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [] } }, "/api/v1/public/menu/{identifier}/images": { "get": { "tags": [ "PublicMenuImages" ], "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variant", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/public/orders": { "get": { "tags": [ "PublicOrders" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ExternalOrderId", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "PublicOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCreateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicCreateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicCreateOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/public/orders/{id}": { "get": { "tags": [ "PublicOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/{id}/apply-approval": { "post": { "tags": [ "PurchaseApprovals" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyPurchaseApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyPurchaseApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyPurchaseApprovalRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/{id}/revert-approval": { "post": { "tags": [ "PurchaseApprovals" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevertPurchaseApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevertPurchaseApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevertPurchaseApprovalRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices/approvals/{approvalRequestId}/apply": { "post": { "tags": [ "PurchaseApprovals" ], "parameters": [ { "name": "approvalRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyDirectReceiveApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyDirectReceiveApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyDirectReceiveApprovalRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices": { "get": { "tags": [ "PurchaseInvoices" ], "parameters": [ { "name": "SupplierId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "MatchStatus", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "PurchaseInvoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivePurchaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReceivePurchaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReceivePurchaseRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices/{id}": { "get": { "tags": [ "PurchaseInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/supplier-returns": { "get": { "tags": [ "PurchaseInvoices" ], "parameters": [ { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "PurchaseInvoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSupplierReturnRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSupplierReturnRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSupplierReturnRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/supplier-returns/{id}": { "get": { "tags": [ "PurchaseInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders": { "get": { "tags": [ "PurchaseOrders" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "SupplierId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "PurchaseOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/{id}": { "get": { "tags": [ "PurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "PurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "PurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetirePurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetirePurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetirePurchaseOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/{id}/submit": { "post": { "tags": [ "PurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/{id}/cancel": { "post": { "tags": [ "PurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelPurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelPurchaseOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/{id}/close": { "post": { "tags": [ "PurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosePurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClosePurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClosePurchaseOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/receipt": { "get": { "tags": [ "Receipts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/kitchen-chits": { "get": { "tags": [ "Receipts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/orders/{id}/receipt/escpos": { "get": { "tags": [ "Receipts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "StationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Kitchen", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/receiving-discrepancies": { "get": { "tags": [ "ReceivingDiscrepancies" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "InventoryItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ReceivingDiscrepancies" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReceivingDiscrepancyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateReceivingDiscrepancyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateReceivingDiscrepancyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/reconciliations/expected": { "get": { "tags": [ "Reconciliation" ], "parameters": [ { "name": "Date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Shift", "in": "query", "schema": { "$ref": "#/components/schemas/OperatingShift" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/reconciliations": { "get": { "tags": [ "Reconciliation" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Shift", "in": "query", "schema": { "$ref": "#/components/schemas/OperatingShift" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Reconciliation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterReconciliationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnterReconciliationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnterReconciliationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/reconciliations/{id}": { "get": { "tags": [ "Reconciliation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Reconciliation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteShiftReconciliationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteShiftReconciliationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteShiftReconciliationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/job-openings": { "get": { "tags": [ "Recruitment" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Recruitment" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJobOpeningRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateJobOpeningRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateJobOpeningRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/job-openings/{id}/status": { "post": { "tags": [ "Recruitment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetJobOpeningStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetJobOpeningStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetJobOpeningStatusRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/candidates": { "get": { "tags": [ "Recruitment" ], "parameters": [ { "name": "JobOpeningId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Stage", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Recruitment" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCandidateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCandidateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCandidateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/candidates/{id}/stage": { "post": { "tags": [ "Recruitment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveCandidateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveCandidateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveCandidateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/candidates/{id}/hire": { "post": { "tags": [ "Recruitment" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HireCandidateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HireCandidateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HireCandidateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/regions": { "get": { "tags": [ "Regions" ], "parameters": [ { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Regions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRegionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRegionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRegionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/regions/{id}": { "put": { "tags": [ "Regions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRegionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRegionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRegionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Regions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireRegionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireRegionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireRegionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/reorder-suggestions": { "get": { "tags": [ "Reorder" ], "parameters": [ { "name": "WindowDays", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-orders/from-suggestions": { "post": { "tags": [ "Reorder" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftPoFromSuggestionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDraftPoFromSuggestionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDraftPoFromSuggestionsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-builder/datasets": { "get": { "tags": [ "ReportBuilder" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-builder/preview": { "post": { "tags": [ "ReportBuilder" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomReportQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomReportQuery" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-builder/reports": { "get": { "tags": [ "ReportBuilder" ], "parameters": [ { "name": "Scope", "in": "query", "schema": { "type": "string" } }, { "name": "Dataset", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ReportBuilder" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveCustomReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveCustomReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveCustomReportRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-builder/reports/{id}": { "get": { "tags": [ "ReportBuilder" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "ReportBuilder" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveCustomReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveCustomReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveCustomReportRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "ReportBuilder" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Reason", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-builder/reports/{id}/run": { "get": { "tags": [ "ReportBuilder" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Preset", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/reports/catalogue": { "get": { "tags": [ "Reports" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/reports/{key}": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Preset", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Compare", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/reports/{key}/export": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Format", "in": "query", "schema": { "type": "string" } }, { "name": "Lang", "in": "query", "schema": { "type": "string" } }, { "name": "Preset", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Compare", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-subscriptions": { "get": { "tags": [ "ReportSubscriptions" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "ReportKey", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "ReportSubscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateReportSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateReportSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-subscriptions/{id}/deactivate": { "post": { "tags": [ "ReportSubscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-subscriptions/{id}/activate": { "post": { "tags": [ "ReportSubscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/report-subscriptions/{id}": { "delete": { "tags": [ "ReportSubscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireReportSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireReportSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireReportSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/sale-invoices/{id}": { "get": { "tags": [ "SaleInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "SaleInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorrectSaleInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CorrectSaleInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CorrectSaleInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "SaleInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TombstoneSaleInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TombstoneSaleInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TombstoneSaleInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/sale-invoices/{id}/restore": { "post": { "tags": [ "SaleInvoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreSaleInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestoreSaleInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RestoreSaleInvoiceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/pos/channels": { "get": { "tags": [ "SalesChannels" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/sales-integrity": { "get": { "tags": [ "SalesIntegrity" ], "parameters": [ { "name": "Threshold", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/comp-void-by-server": { "get": { "tags": [ "SalesIntegrity" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/fraud/adjustments": { "get": { "tags": [ "SalesIntegrity" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/guest/self-order/{qrToken}": { "get": { "tags": [ "SelfOrder" ], "parameters": [ { "name": "qrToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [] } }, "/api/v1/guest/self-order/{qrToken}/quote": { "post": { "tags": [ "SelfOrder" ], "parameters": [ { "name": "qrToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteSelfOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuoteSelfOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QuoteSelfOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [] } }, "/api/v1/guest/self-order/{qrToken}/orders": { "post": { "tags": [ "SelfOrder" ], "parameters": [ { "name": "qrToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitSelfOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitSelfOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitSelfOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [] } }, "/api/v1/console/setup/status": { "get": { "tags": [ "Setup" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/setup": { "post": { "tags": [ "Setup" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInitialOwnerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInitialOwnerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInitialOwnerRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/shelf-life": { "get": { "tags": [ "ShelfLife" ], "parameters": [ { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "WithinDays", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "StockLocationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Bucket", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/shelf-life/propose-waste": { "post": { "tags": [ "ShelfLife" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposeExpiredWasteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProposeExpiredWasteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProposeExpiredWasteRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/shifts": { "get": { "tags": [ "Shifts" ], "parameters": [ { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShiftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShiftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateShiftRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/roster": { "get": { "tags": [ "Shifts" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignShiftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignShiftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignShiftRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/statements/trial-balance": { "get": { "tags": [ "Statements" ], "parameters": [ { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/statements/balance-sheet": { "get": { "tags": [ "Statements" ], "parameters": [ { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/statements/pnl": { "get": { "tags": [ "Statements" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ToExclusive", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/statements/gl-detail": { "get": { "tags": [ "Statements" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ToExclusive", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "AccountCode", "in": "query", "schema": { "type": "string" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/statements/reconciliation": { "get": { "tags": [ "Statements" ], "parameters": [ { "name": "Date", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/statements/export": { "get": { "tags": [ "Statements" ], "parameters": [ { "name": "Statement", "in": "query", "schema": { "type": "string" } }, { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ToExclusive", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "AccountCode", "in": "query", "schema": { "type": "string" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "Format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/stock-locations": { "get": { "tags": [ "StockLocations" ], "parameters": [ { "name": "Kind", "in": "query", "schema": { "type": "string" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "StockLocations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStockLocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateStockLocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateStockLocationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/stock-locations/{id}": { "get": { "tags": [ "StockLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "StockLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStockLocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateStockLocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateStockLocationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "StockLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStockLocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteStockLocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteStockLocationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/stock-locations/{id}/stock": { "get": { "tags": [ "StockLocations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "BelowMinimumOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "NonZeroOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/movements": { "get": { "tags": [ "StockMovements" ], "parameters": [ { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "Location", "in": "query", "schema": { "type": "string" } }, { "name": "StockLocationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/movements/{id}": { "get": { "tags": [ "StockMovements" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/movements/adjustments": { "post": { "tags": [ "StockMovements" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustStockRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdjustStockRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdjustStockRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/subscription": { "get": { "tags": [ "Subscription" ], "parameters": [ { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/subscription/notice": { "get": { "tags": [ "Subscription" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/subscription/plans": { "get": { "tags": [ "Subscription" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/suppliers/{id}/payable": { "get": { "tags": [ "SupplierPayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/suppliers/{id}/payments": { "post": { "tags": [ "SupplierPayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaySupplierRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaySupplierRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PaySupplierRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "get": { "tags": [ "SupplierPayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "PurchaseInvoiceId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Method", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/suppliers/{id}/statement": { "get": { "tags": [ "SupplierPayments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "AsOf", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/suppliers": { "get": { "tags": [ "Suppliers" ], "parameters": [ { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Suppliers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertSupplierRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertSupplierRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertSupplierRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/suppliers/{id}": { "get": { "tags": [ "Suppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Suppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireSupplierRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireSupplierRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireSupplierRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/suppliers/{id}/payment-terms": { "put": { "tags": [ "Suppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierTermsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierTermsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierTermsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/suppliers/{id}/items": { "get": { "tags": [ "Suppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Suppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertSupplierItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertSupplierItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertSupplierItemRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/tax-codes": { "get": { "tags": [ "TaxCodes" ], "parameters": [ { "name": "Kind", "in": "query", "schema": { "type": "string" } }, { "name": "AppliesTo", "in": "query", "schema": { "$ref": "#/components/schemas/TaxAppliesTo" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "TaxCodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaxCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTaxCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTaxCodeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/tax-codes/{id}": { "get": { "tags": [ "TaxCodes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "TaxCodes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaxCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTaxCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTaxCodeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "TaxCodes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTaxCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteTaxCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteTaxCodeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/accounting/tax-codes/{id}/active": { "post": { "tags": [ "TaxCodes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetTaxCodeActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetTaxCodeActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetTaxCodeActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices/{id}/match-lines": { "get": { "tags": [ "ThreeWayMatch" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/purchase-invoices/{id}/clear-match-exception": { "post": { "tags": [ "ThreeWayMatch" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearMatchExceptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClearMatchExceptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClearMatchExceptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers": { "get": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Kind", "in": "query", "schema": { "type": "string" } }, { "name": "Direction", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "TransferOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransferOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTransferOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTransferOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}": { "get": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTransferOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteTransferOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteTransferOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/submit": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/approve": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/reject": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RejectTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RejectTransferRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/pick": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/ship": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/receive": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiveTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReceiveTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReceiveTransferRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/review": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/post": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/central-kitchen/transfers/{id}/cancel": { "post": { "tags": [ "TransferOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelTransferRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/usage-variance": { "get": { "tags": [ "UsageVariance" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/inventory/usage-variance/export": { "get": { "tags": [ "UsageVariance" ], "parameters": [ { "name": "Format", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "RoleId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users/roles": { "get": { "tags": [ "Users" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users/{id}": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireUserRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users/{id}/reset-password": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/users/{id}/resend-invite": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/vault": { "get": { "tags": [ "Vault" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/vault/entries": { "get": { "tags": [ "Vault" ], "parameters": [ { "name": "Account", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/vault/deposits": { "post": { "tags": [ "Vault" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositToVaultRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DepositToVaultRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DepositToVaultRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/vault/withdrawals": { "post": { "tags": [ "Vault" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithdrawFromVaultRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WithdrawFromVaultRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WithdrawFromVaultRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/cash/vault/adjustments": { "post": { "tags": [ "Vault" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustVaultBalanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdjustVaultBalanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdjustVaultBalanceRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/hr/violations": { "get": { "tags": [ "Violations" ], "parameters": [ { "name": "EmployeeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "TypeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Action", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Violations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordViolationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordViolationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordViolationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/vocabularies": { "get": { "tags": [ "Vocabularies" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/vocabularies/{vocabulary}": { "get": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Active", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "post": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/vocabularies/{vocabulary}/{id}": { "get": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "patch": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "put": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }, "delete": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireVocabularyRowRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/vocabularies/{vocabulary}/{id}/active": { "post": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetVocabularyRowActiveRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/settings/vocabularies/{vocabulary}/reorder": { "post": { "tags": [ "Vocabularies" ], "parameters": [ { "name": "vocabulary", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderVocabularyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderVocabularyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderVocabularyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] } }, "/api/v1/console/developers/webhooks": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "IncludeInactive", "in": "query", "schema": { "type": "boolean" } }, { "name": "EventType", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] }, "post": { "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebhookSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/event-types": { "get": { "tags": [ "Webhooks" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/event-catalog": { "get": { "tags": [ "Webhooks" ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireWebhookSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetireWebhookSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetireWebhookSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/{id}/rotate-secret": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/{id}/deactivate": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateWebhookSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeactivateWebhookSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeactivateWebhookSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/{id}/activate": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/{id}/test": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestWebhookSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestWebhookSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TestWebhookSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhooks/{id}/deliveries": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "SubscriptionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "EventType", "in": "query", "schema": { "type": "string" } }, { "name": "ResourceType", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhook-deliveries": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "SubscriptionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "EventType", "in": "query", "schema": { "type": "string" } }, { "name": "ResourceType", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Dir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhook-deliveries/retry-failed": { "post": { "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetryFailedWebhookDeliveriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetryFailedWebhookDeliveriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetryFailedWebhookDeliveriesRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhook-deliveries/{id}": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } }, "/api/v1/console/developers/webhook-deliveries/{id}/retry": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetryWebhookDeliveryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RetryWebhookDeliveryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RetryWebhookDeliveryRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "Bearer": [] } ] } } }, "components": { "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "A console session token (Authorization: Bearer )." }, "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "A machine credential: X-Api-Key: pnp__<8hex>.." } }, "schemas": { "AccountingClosePeriodRequest": { "type": "object", "properties": { "key": { "type": "string" } }, "additionalProperties": false }, "AccountingLockPeriodRequest": { "type": "object", "properties": { "key": { "type": "string" }, "lockThrough": { "type": "string", "format": "date" }, "explanation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccountingReopenPeriodRequest": { "type": "object", "properties": { "key": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false }, "ActivateAccountRequest": { "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" }, "password": { "type": "string" }, "deviceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddBranchToGroupRequest": { "type": "object", "properties": { "branchId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AddEmployeeDocumentRequest": { "type": "object", "properties": { "typeId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "fileUrl": { "type": "string", "nullable": true }, "issueDate": { "type": "string", "format": "date-time", "nullable": true }, "expiryDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "AddProductConsumableRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "qtyPerParentUnit": { "type": "number", "format": "double" }, "unit": { "type": "string", "nullable": true }, "channelScope": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "kind": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AddRecipeIngredientRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "qtyPerParentUnit": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AdjustStockRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "stockLocationId": { "type": "string", "format": "uuid", "nullable": true }, "newQuantity": { "type": "number", "format": "double" }, "reason": { "type": "string" }, "businessDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "AdjustVaultBalanceRequest": { "type": "object", "properties": { "newBalance": { "type": "integer", "format": "int64" }, "reason": { "type": "string" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdoptBranchRequest": { "type": "object", "properties": { "branchId": { "type": "string", "format": "uuid" }, "regionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ApplyCountCorrectionRequest": { "type": "object", "properties": { "approvalRequestId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ApplyDirectReceiveApprovalRequest": { "type": "object", "properties": { "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplyPurchaseApprovalRequest": { "type": "object", "properties": { "approvalRequestId": { "type": "string", "format": "uuid", "nullable": true }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApproveCountRequest": { "type": "object", "properties": { "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssignBranchFranchiseeRequest": { "type": "object", "properties": { "franchiseeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "AssignShiftRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "date": { "type": "string", "format": "date" }, "shiftId": { "type": "string", "format": "uuid", "nullable": true }, "restDay": { "type": "boolean" }, "clear": { "type": "boolean" } }, "additionalProperties": false }, "AttachImageRequest": { "type": "object", "properties": { "assetId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AttendanceMode": { "enum": [ "In", "Out" ], "type": "string" }, "CancelEmailChangeRequest": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CancelOrderRequest": { "type": "object", "properties": { "reason": { "type": "string" }, "disposition": { "type": "string" }, "approverUserId": { "type": "string", "format": "uuid", "nullable": true }, "approverPasscode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CancelPurchaseOrderRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "CancelTransferRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "CaptureCountEvidenceRequest": { "type": "object", "properties": { "image": { "type": "string" } }, "additionalProperties": false }, "ChangePasswordRequest": { "type": "object", "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } }, "additionalProperties": false }, "ChangePublicSlugRequest": { "type": "object", "properties": { "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CheckInOverlayInfo": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClearMatchExceptionRequest": { "type": "object", "properties": { "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClockRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "mode": { "$ref": "#/components/schemas/AttendanceMode" } }, "additionalProperties": false }, "ClosePurchaseOrderRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "ComboChildRequest": { "type": "object", "properties": { "childProductId": { "type": "string", "format": "uuid" }, "quantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CommitProductImportRequest": { "type": "object", "properties": { "format": { "type": "string", "nullable": true }, "content": { "type": "string" } }, "additionalProperties": false }, "CompLineRequest": { "type": "object", "properties": { "reason": { "type": "string" }, "approverUserId": { "type": "string", "format": "uuid", "nullable": true }, "approverPasscode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConfirmGuestPaymentRequest": { "type": "object", "properties": { "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectConnectorRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CorrectSaleInvoiceRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true }, "brandId": { "type": "string", "format": "uuid", "nullable": true }, "clearBrandId": { "type": "boolean" }, "externalOrderId": { "type": "string", "nullable": true }, "clearExternalOrderId": { "type": "boolean" } }, "additionalProperties": false }, "CreateAccountRequest": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "type": { "type": "string" }, "parentCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAdvanceRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "amount": { "type": "integer", "format": "int64" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateApiKeyRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "environment": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "rateLimitPerMinute": { "type": "integer", "format": "int32", "nullable": true }, "quotaPerDay": { "type": "integer", "format": "int64", "nullable": true }, "allowedIps": { "type": "array", "items": { "type": "string" } }, "allowedOrigins": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CreateApprovalRequestRequest": { "type": "object", "properties": { "type": { "type": "string" }, "summary": { "type": "string" }, "payload": { "type": "string", "nullable": true }, "targetType": { "type": "string", "nullable": true }, "targetId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateBankAccountRequest": { "type": "object", "properties": { "name": { "type": "string" }, "accountNumber": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateBatchExtraRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "unit": { "type": "string" } }, "additionalProperties": false }, "CreateBatchTemplateInputRequest": { "type": "object", "properties": { "role": { "type": "string" }, "inventoryItemId": { "type": "string", "format": "uuid", "nullable": true }, "defaultQty": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CreateBatchTemplateOutputRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "allocationWeight": { "type": "number", "format": "double" }, "yieldPerDriverUnit": { "type": "number", "format": "double" }, "shelfLifeHours": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateBatchTemplateRequest": { "type": "object", "properties": { "nameAr": { "type": "string", "nullable": true }, "nameEn": { "type": "string", "nullable": true }, "labourCostIqd": { "type": "integer", "format": "int64" }, "notes": { "type": "string", "nullable": true }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/CreateBatchTemplateOutputRequest" } }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/CreateBatchTemplateInputRequest" } } }, "additionalProperties": false }, "CreateBranchGroupRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "priceTierPct": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CreateBranchRequest": { "type": "object", "properties": { "name": { "type": "string" }, "baseCurrencyCode": { "type": "string" }, "type": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "regionId": { "type": "string", "format": "uuid", "nullable": true }, "legalEntityId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateBrandRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCandidateRequest": { "type": "object", "properties": { "jobOpeningId": { "type": "string", "format": "uuid", "nullable": true }, "fullName": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "cvUrl": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "interviewAt": { "type": "string", "format": "date-time", "nullable": true }, "rating": { "type": "integer", "format": "int32" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateChannelProductMapRequest": { "type": "object", "properties": { "externalProductRef": { "type": "string" }, "productId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateComboRequest": { "type": "object", "properties": { "name": { "type": "string" }, "sellingPrice": { "type": "integer", "format": "int64" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/ComboChildRequest" } } }, "additionalProperties": false }, "CreateCommissionRuleRequest": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "percentage": { "type": "number", "format": "double" }, "commissionMethod": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "active": { "type": "boolean" } }, "additionalProperties": false }, "CreateCustomerInvoiceRequest": { "type": "object", "properties": { "customerName": { "type": "string" }, "customerTaxId": { "type": "string", "nullable": true }, "businessDate": { "type": "string", "format": "date", "nullable": true }, "dueDate": { "type": "string", "format": "date", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceLineInput" } } }, "additionalProperties": false }, "CreateDepartmentRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "CreateDiningAreaRequest": { "type": "object", "properties": { "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateDiningTableRequest": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string", "nullable": true }, "areaId": { "type": "string", "format": "uuid", "nullable": true }, "seats": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateDraftPoFromSuggestionsRequest": { "type": "object", "properties": { "supplierId": { "type": "string", "format": "uuid" }, "expectedDeliveryDate": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/DraftPoSuggestionLineRequest" } } }, "additionalProperties": false }, "CreateEmployeeRequest": { "type": "object", "properties": { "fullName": { "type": "string" }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "nationalId": { "type": "string", "nullable": true }, "photoUrl": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "gender": { "$ref": "#/components/schemas/Gender" }, "maritalStatus": { "$ref": "#/components/schemas/MaritalStatus" }, "emergencyName": { "type": "string", "nullable": true }, "emergencyPhone": { "type": "string", "nullable": true }, "departmentId": { "type": "string", "format": "uuid", "nullable": true }, "positionId": { "type": "string", "format": "uuid", "nullable": true }, "hireDate": { "type": "string", "format": "date", "nullable": true }, "contractType": { "$ref": "#/components/schemas/EmployeeContractType" }, "baseSalary": { "type": "integer", "format": "int64" }, "allowances": { "type": "integer", "format": "int64" }, "annualLeaveBalance": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CreateExportJobRequest": { "type": "object", "properties": { "kind": { "type": "string" }, "reportKey": { "type": "string", "nullable": true }, "savedReportId": { "type": "string", "format": "uuid", "nullable": true }, "format": { "type": "string" }, "lang": { "type": "string", "nullable": true }, "preset": { "type": "string", "nullable": true }, "from": { "type": "string", "format": "date", "nullable": true }, "to": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "CreateFranchiseeRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "royaltyPctBp": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateInitialOwnerRequest": { "type": "object", "properties": { "organizationName": { "type": "string" }, "branchName": { "type": "string" }, "baseCurrencyCode": { "type": "string" }, "ownerName": { "type": "string" }, "ownerEmail": { "type": "string" }, "ownerPassword": { "type": "string" }, "confirmPassword": { "type": "string" } }, "additionalProperties": false }, "CreateInventoryItemRequest": { "type": "object", "properties": { "name": { "type": "string" }, "unitId": { "type": "string", "format": "uuid", "nullable": true }, "category": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "defaultStockLocationId": { "type": "string", "format": "uuid", "nullable": true }, "minStockLevel": { "type": "number", "format": "double" }, "supplierId": { "type": "string", "format": "uuid", "nullable": true }, "active": { "type": "boolean" }, "consumptionUnit": { "type": "string", "nullable": true }, "consumptionPerStockUnit": { "type": "number", "format": "double", "nullable": true }, "purchaseUnit": { "type": "string", "nullable": true }, "purchasePerStockUnit": { "type": "number", "format": "double", "nullable": true }, "eligibleForKitchenTransfer": { "type": "boolean" }, "eligibleForProduction": { "type": "boolean" }, "eligibleForSaleConsumables": { "type": "boolean" }, "valuationMethod": { "type": "string" }, "standardCost": { "type": "number", "format": "double", "nullable": true }, "barcode": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "openingQuantity": { "type": "number", "format": "double" }, "openingUnitCost": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CreateJobOpeningRequest": { "type": "object", "properties": { "title": { "type": "string" }, "departmentId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateKdsStationRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "CreateLeaveRequestRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "typeId": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateLegalEntityRequest": { "type": "object", "properties": { "name": { "type": "string" }, "taxId": { "type": "string", "nullable": true }, "currency": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "CreateLoanRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "principal": { "type": "integer", "format": "int64" }, "installment": { "type": "integer", "format": "int64" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateModifierGroupRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "minSelect": { "type": "integer", "format": "int32" }, "maxSelect": { "type": "integer", "format": "int32" }, "required": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateModifierOptionRequest": { "type": "object", "properties": { "groupId": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "priceDeltaIqd": { "type": "integer", "format": "int64" }, "isDefault": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "inventoryItemId": { "type": "string", "format": "uuid", "nullable": true }, "qtyPerParentUnit": { "type": "number", "format": "double", "nullable": true }, "sign": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "reportingCurrencyCode": { "type": "string" } }, "additionalProperties": false }, "CreatePerformanceReviewRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "periodLabel": { "type": "string" }, "attendanceScore": { "type": "integer", "format": "int32" }, "disciplineScore": { "type": "integer", "format": "int32" }, "productivityScore": { "type": "integer", "format": "int32" }, "customerServiceScore": { "type": "integer", "format": "int32" }, "teamworkScore": { "type": "integer", "format": "int32" }, "kitchenScore": { "type": "integer", "format": "int32" }, "salesScore": { "type": "integer", "format": "int32" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatePilotRequest": { "type": "object", "properties": { "restaurantName": { "type": "string" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatePositionRequest": { "type": "object", "properties": { "title": { "type": "string" }, "departmentId": { "type": "string", "format": "uuid", "nullable": true }, "baseSalary": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CreateProductCategoryRequest": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "nameAr": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "metadata": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateProductRequest": { "type": "object", "properties": { "name": { "type": "string" }, "categoryId": { "type": "string", "format": "uuid" }, "sellingPrice": { "type": "integer", "format": "int64" }, "externalId": { "type": "string", "nullable": true }, "capacityType": { "type": "string", "nullable": true }, "capacityUnits": { "type": "integer", "format": "int32" }, "riceRole": { "type": "string" }, "directRiceG": { "type": "integer", "format": "int32" }, "brandId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateProductionBatchRequest": { "type": "object", "properties": { "businessDate": { "type": "string", "format": "date", "nullable": true }, "chickenItemId": { "type": "string", "format": "uuid", "nullable": true }, "chickenCount": { "type": "integer", "format": "int32" }, "meatItemId": { "type": "string", "format": "uuid", "nullable": true }, "meatKg": { "type": "number", "format": "double" }, "riceItemId": { "type": "string", "format": "uuid", "nullable": true }, "rawRiceKg": { "type": "number", "format": "double" }, "cookedRiceMultiplier": { "type": "number", "format": "double" }, "reservedRiceDirectSaleKg": { "type": "number", "format": "double" }, "riceRoundingMethod": { "type": "string" }, "extras": { "type": "array", "items": { "$ref": "#/components/schemas/CreateBatchExtraRequest" } }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatePromotionRequest": { "type": "object", "properties": { "name": { "type": "string" }, "discountPercent": { "type": "number", "format": "double" }, "maxDiscountCap": { "type": "integer", "format": "int64" }, "minOrderValue": { "type": "integer", "format": "int64" }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "channelId": { "type": "string", "format": "uuid", "nullable": true }, "active": { "type": "boolean" } }, "additionalProperties": false }, "CreatePurchaseOrderRequest": { "type": "object", "properties": { "supplierId": { "type": "string", "format": "uuid" }, "expectedDeliveryDate": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineRequest" } } }, "additionalProperties": false }, "CreateReceivingDiscrepancyRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "purchaseInvoiceItemId": { "type": "string", "format": "uuid", "nullable": true }, "orderedQty": { "type": "number", "format": "double" }, "receivedQty": { "type": "number", "format": "double" }, "unitCostIqd": { "type": "number", "format": "double" }, "businessDate": { "type": "string", "format": "date", "nullable": true }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateRegionRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateReportSubscriptionRequest": { "type": "object", "properties": { "reportKey": { "type": "string" }, "recipientEmail": { "type": "string" }, "cadence": { "$ref": "#/components/schemas/ReportCadence" }, "format": { "$ref": "#/components/schemas/ExportFormat" } }, "additionalProperties": false }, "CreateSaleLineRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "quantity": { "type": "integer", "format": "int32" }, "taxCodeId": { "type": "string", "format": "uuid", "nullable": true }, "manualDiscountIqd": { "type": "integer", "format": "int64", "nullable": true }, "discountReason": { "type": "string", "nullable": true }, "modifierOptionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "seatNumber": { "type": "integer", "format": "int32", "nullable": true }, "courseNumber": { "type": "integer", "format": "int32", "nullable": true }, "stationId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateSaleRequest": { "type": "object", "properties": { "idempotencyKey": { "type": "string" }, "channelId": { "type": "string", "format": "uuid" }, "shift": { "type": "string" }, "brandId": { "type": "string", "format": "uuid", "nullable": true }, "diningTableId": { "type": "string", "format": "uuid", "nullable": true }, "waiterId": { "type": "string", "format": "uuid", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CreateSaleLineRequest" } }, "tenders": { "type": "array", "items": { "$ref": "#/components/schemas/SaleTenderRequest" } }, "checkDiscountIqd": { "type": "integer", "format": "int64" }, "discountReason": { "type": "string", "nullable": true }, "splitBySeat": { "type": "boolean" }, "externalOrderId": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "replayMode": { "type": "boolean" }, "capturedAt": { "type": "string", "format": "date-time", "nullable": true }, "clientSeq": { "type": "integer", "format": "int64", "nullable": true }, "deviceId": { "type": "string", "nullable": true }, "approverUserId": { "type": "string", "format": "uuid", "nullable": true }, "approverPasscode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateShiftRequest": { "type": "object", "properties": { "name": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" } }, "additionalProperties": false }, "CreateStockLocationRequest": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "parentLocationId": { "type": "string", "format": "uuid", "nullable": true }, "allowsSales": { "type": "boolean" }, "allowsProduction": { "type": "boolean" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "CreateSupplierReturnRequest": { "type": "object", "properties": { "purchaseInvoiceId": { "type": "string", "format": "uuid" }, "businessDate": { "type": "string", "format": "date" }, "reason": { "type": "string" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierReturnLineRequest" } } }, "additionalProperties": false }, "CreateTaxCodeRequest": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "ratePermille": { "type": "integer", "format": "int32" }, "appliesTo": { "$ref": "#/components/schemas/TaxAppliesTo" } }, "additionalProperties": false }, "CreateTransferLineRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "lotNo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateTransferOrderRequest": { "type": "object", "properties": { "kind": { "type": "string" }, "destBranchId": { "type": "string", "format": "uuid", "nullable": true }, "sourceLocationId": { "type": "string", "format": "uuid" }, "transitLocationId": { "type": "string", "format": "uuid", "nullable": true }, "destLocationId": { "type": "string", "format": "uuid" }, "notes": { "type": "string", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTransferLineRequest" } } }, "additionalProperties": false }, "CreateUserRequest": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateVocabularyRowRequest": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "nameAr": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "metadata": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateWebhookSubscriptionRequest": { "type": "object", "properties": { "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "apiVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomReportAggregate": { "type": "object", "properties": { "field": { "type": "string" }, "fn": { "type": "string" } }, "additionalProperties": false }, "CustomReportFilter": { "type": "object", "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CustomReportQuery": { "type": "object", "properties": { "dataset": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "groupBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "aggregates": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportAggregate" }, "nullable": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportFilter" }, "nullable": true }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportSort" }, "nullable": true }, "limit": { "type": "integer", "format": "int32", "nullable": true }, "preset": { "type": "string", "nullable": true }, "from": { "type": "string", "format": "date", "nullable": true }, "to": { "type": "string", "format": "date", "nullable": true }, "branchIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CustomReportSort": { "type": "object", "properties": { "field": { "type": "string" }, "dir": { "type": "string" } }, "additionalProperties": false }, "CustomerInvoiceLineInput": { "type": "object", "properties": { "description": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "unitPriceIqd": { "type": "integer", "format": "int64" }, "taxCodeId": { "type": "string", "format": "uuid", "nullable": true }, "sourceOrderId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DeactivateWebhookSubscriptionRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecideAdvanceRequest": { "type": "object", "properties": { "decision": { "type": "string" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecideApprovalRequestRequest": { "type": "object", "properties": { "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecideCheckInEvidenceRequest": { "type": "object", "properties": { "decision": { "type": "string" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecideLeaveRequest": { "type": "object", "properties": { "decision": { "type": "string" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecideLoanRequest": { "type": "object", "properties": { "decision": { "type": "string" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteAccountRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteBranchRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteChannelProductMapRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteComboRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteCustomerInvoiceRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteDiningAreaRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteDiningTableRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteInventoryItemRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteKdsStationRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeletePeriodRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeletePilotRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteShiftReconciliationRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteStockLocationRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteTaxCodeRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeleteTransferOrderRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "DeliveryReviewLineRequest": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "hasUnreceived": { "type": "boolean" } }, "additionalProperties": false }, "DepositToVaultRequest": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" }, "reason": { "type": "string" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DraftPoSuggestionLineRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "EmployeeContractType": { "enum": [ "FullTime", "PartTime", "Temporary", "Daily" ], "type": "string" }, "EmploymentStatus": { "enum": [ "Active", "Suspended", "Resigned", "Terminated" ], "type": "string" }, "EnterReconciliationRequest": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "shift": { "$ref": "#/components/schemas/OperatingShift" }, "countedCash": { "type": "integer", "format": "int64" }, "settledCard": { "type": "integer", "format": "int64" }, "note": { "type": "string", "nullable": true }, "clientOpId": { "type": "string", "nullable": true }, "capturedAt": { "type": "string", "format": "date-time", "nullable": true }, "deviceId": { "type": "string", "nullable": true }, "expectedSnapshot": { "$ref": "#/components/schemas/ExpectedSnapshotRequest" } }, "additionalProperties": false }, "ExchangeRateType": { "enum": [ "Spot", "PeriodAverage", "Budget", "Closing" ], "type": "string" }, "ExcludeBankLineRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExpectedSnapshotRequest": { "type": "object", "properties": { "expectedCash": { "type": "integer", "format": "int64", "nullable": true }, "expectedCard": { "type": "integer", "format": "int64", "nullable": true }, "orderCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ExportFormat": { "enum": [ "Xlsx", "Pdf" ], "type": "string" }, "ForgotPasswordRequest": { "type": "object", "properties": { "email": { "type": "string" } }, "additionalProperties": false }, "Gender": { "enum": [ "Male", "Female" ], "type": "string" }, "GeneratePayrollRunRequest": { "type": "object", "properties": { "month": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GrantBranchMembershipRequest": { "type": "object", "properties": { "branchId": { "type": "string", "format": "uuid" }, "roleId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "HireCandidateRequest": { "type": "object", "properties": { "departmentId": { "type": "string", "format": "uuid", "nullable": true }, "positionId": { "type": "string", "format": "uuid", "nullable": true }, "hireDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "ImportBankStatementRequest": { "type": "object", "properties": { "csv": { "type": "string" } }, "additionalProperties": false }, "ImportSettlementRequest": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "periodFrom": { "type": "string", "format": "date" }, "periodTo": { "type": "string", "format": "date" }, "netPaid": { "type": "integer", "format": "int64" }, "currencyCode": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "statement": { "type": "string" } }, "additionalProperties": false }, "IssueCheckInSessionRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "mode": { "$ref": "#/components/schemas/AttendanceMode" } }, "additionalProperties": false }, "IssueCustomerInvoiceRequest": { "type": "object", "properties": { "memo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LedgerShift": { "enum": [ "Morning", "Evening", "All" ], "type": "string" }, "LockBusinessDayRequest": { "type": "object", "properties": { "businessDate": { "type": "string", "format": "date" }, "explanation": { "type": "string", "nullable": true }, "shift": { "$ref": "#/components/schemas/LedgerShift" } }, "additionalProperties": false }, "LoginRequest": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "branchId": { "type": "string", "format": "uuid", "nullable": true }, "deviceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LogoutRequest": { "type": "object", "properties": { "refreshToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LossControlClosePeriodRequest": { "type": "object", "properties": { "key": { "type": "string" } }, "additionalProperties": false }, "LossControlLockPeriodRequest": { "type": "object", "properties": { "key": { "type": "string" }, "lockedThrough": { "type": "string", "format": "date" }, "explanation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LossControlReopenPeriodRequest": { "type": "object", "properties": { "key": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false }, "LossSummaryGrouping": { "enum": [ "Day", "Shift", "Material", "Severity" ], "type": "string" }, "MaritalStatus": { "enum": [ "Single", "Married", "Divorced", "Widowed" ], "type": "string" }, "MatchBankLineRequest": { "type": "object", "properties": { "matchType": { "type": "string" }, "matchedRef": { "type": "string" } }, "additionalProperties": false }, "MoveCandidateRequest": { "type": "object", "properties": { "stage": { "type": "string" }, "interviewAt": { "type": "string", "format": "date-time", "nullable": true }, "rating": { "type": "integer", "format": "int32", "nullable": true }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoveOrderTableRequest": { "type": "object", "properties": { "toTableId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "OAuthConsentRequest": { "type": "object", "properties": { "clientId": { "type": "string" }, "redirectUri": { "type": "string" }, "scope": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "codeChallenge": { "type": "string", "nullable": true }, "codeChallengeMethod": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OAuthRegisterClientRequest": { "type": "object", "properties": { "client_name": { "type": "string", "nullable": true }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "nullable": true }, "token_endpoint_auth_method": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OperatingShift": { "enum": [ "Morning", "Evening" ], "type": "string" }, "OwnerImagesBatchRequest": { "type": "object", "properties": { "ownerType": { "type": "string" }, "ownerIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "variant": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParseEodTextRequest": { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false }, "PaySupplierRequest": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PostDailySalesRequest": { "type": "object", "properties": { "date": { "type": "string", "format": "date" } }, "additionalProperties": false }, "PricePreviewLineRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "quantity": { "type": "integer", "format": "int32" }, "modifierOptionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "manualDiscountIqd": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "PricePreviewRequest": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PricePreviewLineRequest" } }, "promotionId": { "type": "string", "format": "uuid", "nullable": true }, "manualDiscountIqd": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "ProductImportDryRunRequest": { "type": "object", "properties": { "format": { "type": "string", "nullable": true }, "content": { "type": "string" } }, "additionalProperties": false }, "ProposeExpiredWasteRequest": { "type": "object", "properties": { "stockLocationId": { "type": "string", "format": "uuid" }, "inventoryItemId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PublicCreateOrderLineRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "quantity": { "type": "integer", "format": "int32" }, "modifierOptionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "PublicCreateOrderRequest": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "shift": { "type": "string" }, "brandId": { "type": "string", "format": "uuid", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCreateOrderLineRequest" } }, "tenders": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCreateOrderTenderRequest" } }, "externalOrderId": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "capturedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PublicCreateOrderTenderRequest": { "type": "object", "properties": { "methodId": { "type": "string", "format": "uuid" }, "amount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PurchaseOrderLineRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "unitCost": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "QuoteSelfOrderRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SelfOrderItemRequest" } } }, "additionalProperties": false }, "RecalculateProductCostsRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid", "nullable": true }, "inventoryItemId": { "type": "string", "format": "uuid", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReceiveLineRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "unitCost": { "type": "integer", "format": "int64" }, "lotNumber": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "format": "date", "nullable": true }, "purchaseOrderItemId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ReceivePurchaseRequest": { "type": "object", "properties": { "supplierId": { "type": "string", "format": "uuid" }, "purchaseOrderId": { "type": "string", "format": "uuid", "nullable": true }, "paymentType": { "type": "string" }, "paidAmount": { "type": "integer", "format": "int64" }, "stockLocationId": { "type": "string", "format": "uuid", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiveLineRequest" } } }, "additionalProperties": false }, "ReceiveTransferLineRequest": { "type": "object", "properties": { "transferLineId": { "type": "string", "format": "uuid" }, "receivedQty": { "type": "number", "format": "double" }, "varianceReasonId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ReceiveTransferRequest": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiveTransferLineRequest" } } }, "additionalProperties": false }, "RecordAttendanceRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "clockIn": { "type": "string", "format": "date-time", "nullable": true }, "clockOut": { "type": "string", "format": "date-time", "nullable": true }, "breakMinutes": { "type": "integer", "format": "int32" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordBatchWasteRequest": { "type": "object", "properties": { "capacityTypeId": { "type": "string", "format": "uuid" }, "units": { "type": "integer", "format": "int32" }, "kind": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false }, "RecordCustomerInvoicePaymentRequest": { "type": "object", "properties": { "amountIqd": { "type": "integer", "format": "int64" }, "method": { "type": "string" }, "reference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordDeliverySettlementRequest": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "amount": { "type": "integer", "format": "int64" }, "transferDate": { "type": "string", "format": "date", "nullable": true }, "reference": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordExchangeRateRequest": { "type": "object", "properties": { "fromCurrencyCode": { "type": "string" }, "toCurrencyCode": { "type": "string" }, "rateType": { "$ref": "#/components/schemas/ExchangeRateType" }, "rate": { "type": "number", "format": "double" }, "validFrom": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "string" } }, "additionalProperties": false }, "RecordPortionCheckRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "inventoryItemId": { "type": "string", "format": "uuid" }, "specQty": { "type": "number", "format": "double" }, "measuredQty": { "type": "number", "format": "double" }, "sampleSize": { "type": "integer", "format": "int32" }, "evidenceSourceId": { "type": "string", "format": "uuid", "nullable": true }, "businessDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "RecordProductionOutputRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "outputQty": { "type": "number", "format": "double" }, "shareIqd": { "type": "integer", "format": "int64" }, "allocationWeight": { "type": "integer", "format": "int32" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RecordStaffMealRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "location": { "$ref": "#/components/schemas/StockBook" }, "shift": { "$ref": "#/components/schemas/OperatingShift" }, "qty": { "type": "number", "format": "double" }, "reason": { "type": "string", "nullable": true }, "businessDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "RecordViolationRequest": { "type": "object", "properties": { "employeeId": { "type": "string", "format": "uuid" }, "typeId": { "type": "string", "format": "uuid" }, "action": { "type": "string" }, "penaltyAmount": { "type": "integer", "format": "int64" }, "description": { "type": "string" } }, "additionalProperties": false }, "RefreshImageUrlsRequest": { "type": "object", "properties": { "assetIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "variant": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RefreshTokenRequest": { "type": "object", "properties": { "refreshToken": { "type": "string" } }, "additionalProperties": false }, "RefundLineRequest": { "type": "object", "properties": { "orderItemId": { "type": "string", "format": "uuid" }, "disposition": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RefundOrderRequest": { "type": "object", "properties": { "reason": { "type": "string" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/RefundLineRequest" } }, "approverUserId": { "type": "string", "format": "uuid", "nullable": true }, "approverPasscode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegisterOAuthClientRequest": { "type": "object", "properties": { "name": { "type": "string" }, "redirectUris": { "type": "array", "items": { "type": "string" } }, "scopes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "RegisterStartRequest": { "type": "object", "properties": { "organizationName": { "type": "string" }, "branchName": { "type": "string" }, "baseCurrencyCode": { "type": "string" }, "ownerName": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "RegisterVerifyRequest": { "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" }, "password": { "type": "string" }, "deviceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RejectGuestPaymentRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RejectKitchenTransferRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RejectTransferRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "ReleaseIdempotencyKeyRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RemoveBranchFromGroupRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "ReopenBankLineRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReorderGalleryRequest": { "type": "object", "properties": { "assetIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "ReorderVocabularyRequest": { "type": "object", "properties": { "order": { "type": "array", "items": { "$ref": "#/components/schemas/VocabularyOrderEntry" } } }, "additionalProperties": false }, "ReplayOutboxMessageRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "ReportCadence": { "enum": [ "Daily", "Weekly", "Monthly" ], "type": "string" }, "RequestKitchenTransferRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "sourceLocationId": { "type": "string", "format": "uuid", "nullable": true }, "destLocationId": { "type": "string", "format": "uuid", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResendEmailChangeRequest": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "target": { "type": "string" } }, "additionalProperties": false }, "ResendVerificationRequest": { "type": "object", "properties": { "email": { "type": "string" }, "purpose": { "type": "string" } }, "additionalProperties": false }, "ResetDashboardLayoutRequest": { "type": "object", "properties": { "scope": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "reason": { "type": "string" } }, "additionalProperties": false }, "ResetPasswordRequest": { "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false }, "ResetUserPasswordRequest": { "type": "object", "properties": { "newPassword": { "type": "string" } }, "additionalProperties": false }, "ResolveFraudCaseRequest": { "type": "object", "properties": { "status": { "type": "string" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RestoreSaleInvoiceRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RetireBatchTemplateRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireBranchGroupRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireBrandRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireEmployeeDocumentRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireEmployeeRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireExportPresetRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireLegalEntityRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireModifierGroupRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireModifierOptionRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireOrgUnitRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireOrganizationRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireProductCategoryRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireProductRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireProductionBatchRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetirePromotionRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetirePurchaseOrderRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireRegionRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireReportSubscriptionRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireSupplierRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireUserRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireVocabularyRowRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetireWebhookSubscriptionRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RetryFailedWebhookDeliveriesRequest": { "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "RetryWebhookDeliveryRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReverseProductionOutputRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RevertPurchaseApprovalRequest": { "type": "object", "properties": { "approvalRequestId": { "type": "string", "format": "uuid", "nullable": true }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RevokeApiKeyRequest": { "type": "object", "properties": { "reasonCode": { "type": "string" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RevokeBranchMembershipRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RevokeOAuthClientRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "RotateApiKeyRequest": { "type": "object", "properties": { "graceMinutes": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SaleTenderRequest": { "type": "object", "properties": { "methodId": { "type": "string", "format": "uuid" }, "amountIqd": { "type": "integer", "format": "int64" }, "tenderedIqd": { "type": "integer", "format": "int64", "nullable": true }, "seatNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SaveCustomReportRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "shared": { "type": "boolean" }, "query": { "$ref": "#/components/schemas/CustomReportQuery" } }, "additionalProperties": false }, "SaveDashboardLayoutRequest": { "type": "object", "properties": { "scope": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "tiles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SaveEodReportRequest": { "type": "object", "properties": { "businessDate": { "type": "string", "format": "date" }, "grossSalesIqd": { "type": "integer", "format": "int64" }, "netSalesIqd": { "type": "integer", "format": "int64" }, "cashSalesIqd": { "type": "integer", "format": "int64" }, "cardSalesIqd": { "type": "integer", "format": "int64" }, "qiSalesIqd": { "type": "integer", "format": "int64" }, "deliverySalesIqd": { "type": "integer", "format": "int64" }, "source": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SaveExportPresetRequest": { "type": "object", "properties": { "domain": { "type": "string" }, "name": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "importCompatible": { "type": "boolean" } }, "additionalProperties": false }, "SeedChartRequest": { "type": "object", "properties": { "dryRun": { "type": "boolean" } }, "additionalProperties": false }, "SelfOrderItemRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "quantity": { "type": "integer", "format": "int32" }, "modifierOptionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "SelfOrderPaymentRequest": { "type": "object", "properties": { "methodId": { "type": "string", "format": "uuid" }, "amountIqd": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SetAccountActiveRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetBrandActiveRequest": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false }, "SetCommissionRuleActiveRequest": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false }, "SetCustomDomainRequest": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetDiningTableActiveRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetEmploymentStatusRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/EmploymentStatus" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetEvidenceDisputeRequest": { "type": "object", "properties": { "dispute": { "type": "string" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetJobOpeningStatusRequest": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": false }, "SetOrgAdminRequest": { "type": "object", "properties": { "isOrgAdmin": { "type": "boolean" }, "reason": { "type": "string" } }, "additionalProperties": false }, "SetPilotStatusRequest": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": false }, "SetProductAvailabilityRequest": { "type": "object", "properties": { "is86": { "type": "boolean" } }, "additionalProperties": false }, "SetProductionBatchOverflowRequest": { "type": "object", "properties": { "allowDirectRiceOverflow": { "type": "boolean" } }, "additionalProperties": false }, "SetProductionBatchStatusRequest": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": false }, "SetPromotionActiveRequest": { "type": "object", "properties": { "active": { "type": "boolean" } }, "additionalProperties": false }, "SetPublicMenuEnabledRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "SetTaxCodeActiveRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetVocabularyRowActiveRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StartEmailChangeRequest": { "type": "object", "properties": { "newEmail": { "type": "string" }, "currentPassword": { "type": "string" } }, "additionalProperties": false }, "StockBook": { "enum": [ "Warehouse", "Kitchen" ], "type": "string" }, "SubmitCheckInEvidenceRequest": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid" }, "employeeId": { "type": "string", "format": "uuid" }, "mode": { "$ref": "#/components/schemas/AttendanceMode" }, "capturedAt": { "type": "string", "format": "date-time" }, "image": { "type": "string" }, "faceMatchPct": { "type": "number", "format": "double", "nullable": true }, "faceCount": { "type": "integer", "format": "int32", "nullable": true }, "overlay": { "$ref": "#/components/schemas/CheckInOverlayInfo" }, "device": { "type": "string", "nullable": true }, "gps": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubmitCountLineRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "countedQty": { "type": "number", "format": "double" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubmitCountRequest": { "type": "object", "properties": { "shift": { "$ref": "#/components/schemas/OperatingShift" }, "location": { "$ref": "#/components/schemas/StockBook" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SubmitCountLineRequest" } }, "note": { "type": "string", "nullable": true }, "clientOpId": { "type": "string", "nullable": true }, "capturedAt": { "type": "string", "format": "date-time", "nullable": true }, "deviceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubmitDeliveryReviewRequest": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryReviewLineRequest" } }, "returns": { "type": "array", "items": { "$ref": "#/components/schemas/UnreceivedOrderRequest" } }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubmitSelfOrderRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SelfOrderItemRequest" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/SelfOrderPaymentRequest" } } }, "additionalProperties": false }, "SupplierReturnLineRequest": { "type": "object", "properties": { "purchaseInvoiceItemId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SwitchBranchRequest": { "type": "object", "properties": { "branchId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "TaxAppliesTo": { "enum": [ "Sales", "Purchases", "Both" ], "type": "string" }, "TestWebhookSubscriptionRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TombstoneFraudCaseRequest": { "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "TombstoneSaleInvoiceRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TransitionKdsTicketRequest": { "type": "object", "properties": { "action": { "type": "string" } }, "additionalProperties": false }, "UnreceivedOrderRequest": { "type": "object", "properties": { "orderId": { "type": "string", "format": "uuid" }, "returnCondition": { "type": "string" }, "customerName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateAccountRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "parentCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateApiKeyRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "rateLimitPerMinute": { "type": "integer", "format": "int32", "nullable": true }, "quotaPerDay": { "type": "integer", "format": "int64", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UpdateBranchGroupRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "priceTierPct": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateBranchRequest": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "regionId": { "type": "string", "format": "uuid", "nullable": true }, "legalEntityId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdateBrandRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateComboRequest": { "type": "object", "properties": { "sellingPrice": { "type": "integer", "format": "int64", "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/ComboChildRequest" }, "nullable": true }, "active": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateCustomerInvoiceRequest": { "type": "object", "properties": { "customerName": { "type": "string" }, "customerTaxId": { "type": "string", "nullable": true }, "businessDate": { "type": "string", "format": "date", "nullable": true }, "dueDate": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceLineInput" } } }, "additionalProperties": false }, "UpdateDepartmentRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "UpdateDiningAreaRequest": { "type": "object", "properties": { "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "UpdateDiningTableRequest": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string", "nullable": true }, "areaId": { "type": "string", "format": "uuid", "nullable": true }, "seats": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdateEmployeeRequest": { "type": "object", "properties": { "fullName": { "type": "string" }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "nationalId": { "type": "string", "nullable": true }, "photoUrl": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "gender": { "$ref": "#/components/schemas/Gender" }, "maritalStatus": { "$ref": "#/components/schemas/MaritalStatus" }, "emergencyName": { "type": "string", "nullable": true }, "emergencyPhone": { "type": "string", "nullable": true }, "departmentId": { "type": "string", "format": "uuid", "nullable": true }, "positionId": { "type": "string", "format": "uuid", "nullable": true }, "hireDate": { "type": "string", "format": "date", "nullable": true }, "contractType": { "$ref": "#/components/schemas/EmployeeContractType" }, "baseSalary": { "type": "integer", "format": "int64" }, "allowances": { "type": "integer", "format": "int64" }, "annualLeaveBalance": { "type": "number", "format": "double" } }, "additionalProperties": false }, "UpdateEodReportRequest": { "type": "object", "properties": { "grossSalesIqd": { "type": "integer", "format": "int64" }, "netSalesIqd": { "type": "integer", "format": "int64" }, "cashSalesIqd": { "type": "integer", "format": "int64" }, "cardSalesIqd": { "type": "integer", "format": "int64" }, "qiSalesIqd": { "type": "integer", "format": "int64" }, "deliverySalesIqd": { "type": "integer", "format": "int64" }, "source": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateFranchiseeRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "royaltyPctBp": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "UpdateInventoryItemRequest": { "type": "object", "properties": { "name": { "type": "string" }, "unitId": { "type": "string", "format": "uuid", "nullable": true }, "category": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "defaultStockLocationId": { "type": "string", "format": "uuid", "nullable": true }, "minStockLevel": { "type": "number", "format": "double" }, "supplierId": { "type": "string", "format": "uuid", "nullable": true }, "active": { "type": "boolean" }, "consumptionUnit": { "type": "string", "nullable": true }, "consumptionPerStockUnit": { "type": "number", "format": "double", "nullable": true }, "purchaseUnit": { "type": "string", "nullable": true }, "purchasePerStockUnit": { "type": "number", "format": "double", "nullable": true }, "eligibleForKitchenTransfer": { "type": "boolean" }, "eligibleForProduction": { "type": "boolean" }, "eligibleForSaleConsumables": { "type": "boolean" }, "valuationMethod": { "type": "string" }, "standardCost": { "type": "number", "format": "double", "nullable": true }, "barcode": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateKdsStationRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "UpdateLegalEntityRequest": { "type": "object", "properties": { "name": { "type": "string" }, "taxId": { "type": "string", "nullable": true }, "currency": { "type": "string" }, "isDefault": { "type": "boolean" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "UpdateOrderStatusRequest": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": false }, "UpdateOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "reportingCurrencyCode": { "type": "string" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "UpdatePayslipRequest": { "type": "object", "properties": { "bonuses": { "type": "integer", "format": "int64" }, "commissions": { "type": "integer", "format": "int64" }, "deductions": { "type": "integer", "format": "int64" }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdatePilotRequest": { "type": "object", "properties": { "restaurantName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "note": { "type": "string", "nullable": true }, "checklist": { "nullable": true }, "finalReportStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdatePositionRequest": { "type": "object", "properties": { "title": { "type": "string" }, "departmentId": { "type": "string", "format": "uuid", "nullable": true }, "baseSalary": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "UpdateProductCategoryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "nameAr": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "active": { "type": "boolean", "nullable": true }, "metadata": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateProductPriceRequest": { "type": "object", "properties": { "sellingPrice": { "type": "integer", "format": "int64" }, "unitCost": { "type": "number", "format": "double", "nullable": true }, "active": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateProductionBatchRequest": { "type": "object", "properties": { "cookedRiceMultiplier": { "type": "number", "format": "double" }, "reservedRiceDirectSaleKg": { "type": "number", "format": "double" }, "riceRoundingMethod": { "type": "string" } }, "additionalProperties": false }, "UpdatePurchaseOrderRequest": { "type": "object", "properties": { "supplierId": { "type": "string", "format": "uuid" }, "expectedDeliveryDate": { "type": "string", "format": "date", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineRequest" } } }, "additionalProperties": false }, "UpdateRegionRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateStockLocationRequest": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "parentLocationId": { "type": "string", "format": "uuid", "nullable": true }, "allowsSales": { "type": "boolean" }, "allowsProduction": { "type": "boolean" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "UpdateSupplierTermsRequest": { "type": "object", "properties": { "paymentTermsDays": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateTaxCodeRequest": { "type": "object", "properties": { "name": { "type": "string" }, "nameAr": { "type": "string", "nullable": true }, "ratePermille": { "type": "integer", "format": "int32" }, "appliesTo": { "$ref": "#/components/schemas/TaxAppliesTo" } }, "additionalProperties": false }, "UpdateUserRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "roleId": { "type": "string", "format": "uuid", "nullable": true }, "branchId": { "type": "string", "format": "uuid", "nullable": true }, "active": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateVocabularyRowRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "nameAr": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "active": { "type": "boolean", "nullable": true }, "metadata": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateWebhookSubscriptionRequest": { "type": "object", "properties": { "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "apiVersion": { "type": "string", "nullable": true }, "active": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpsertDeliveryPolicyRequest": { "type": "object", "properties": { "channelId": { "type": "string", "format": "uuid" }, "discountContributionPct": { "type": "number", "format": "double" }, "maxContributionAmount": { "type": "integer", "format": "int64" }, "returnRequired": { "type": "boolean" }, "compensationPct": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "active": { "type": "boolean" } }, "additionalProperties": false }, "UpsertSupplierItemRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "uuid" }, "isPreferred": { "type": "boolean" }, "leadTimeDays": { "type": "integer", "format": "int32" }, "minOrderQty": { "type": "number", "format": "double" } }, "additionalProperties": false }, "UpsertSupplierRequest": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "paymentTermsDays": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValidateModifierSelectionRequest": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "optionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "VerifyEmailChangeRequest": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "oldCode": { "type": "string" }, "newCode": { "type": "string" } }, "additionalProperties": false }, "VocabularyOrderEntry": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VoidCustomerInvoiceRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VoidLineRequest": { "type": "object", "properties": { "reason": { "type": "string" }, "fired": { "type": "boolean", "nullable": true }, "approverUserId": { "type": "string", "format": "uuid", "nullable": true }, "approverPasscode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WithdrawFromVaultRequest": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" }, "reason": { "type": "string" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }