{ "openapi": "3.0.4", "info": { "title": "gals.service.backend", "version": "v1", "description": "GALS backend HTTP API. This seed file is overwritten by CI via Swashbuckle CLI (`dotnet swagger tofile`)." }, "servers": [ { "url": "http://localhost:7137", "description": "Local" }, { "url": "https://gals-api-dev2-c98f.italynorth.azurecontainer.io", "description": "PTL DEV" } ], "tags": [ { "name": "Health" }, { "name": "Contract" }, { "name": "CycleInvoicing" }, { "name": "Undertaking" }, { "name": "Reconciliation" }, { "name": "Reports" }, { "name": "Rule" }, { "name": "Employee" }, { "name": "RolePermission" }, { "name": "Audit" } ], "paths": { "/hc": { "get": { "summary": "Health check", "tags": [ "Health" ], "security": [], "responses": { "200": { "description": "Healthy" } } } }, "/Contract/Create": { "post": { "summary": "Create contract", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractDto" } } } } } }, "/Contract/GetList": { "get": { "summary": "List contracts by base year", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "baseYear", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Contract/Update": { "put": { "summary": "Update contract", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractDto" } } } } } }, "/Contract/Delete": { "delete": { "summary": "Delete contract", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Contract/Run": { "post": { "summary": "Run contract rollover", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "targetYear", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "copyMode", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/Contract/SyncYearEnd": { "post": { "summary": "Sync contract year end", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "targetYear", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Contract/GetCustomers": { "get": { "summary": "List Business Central customers", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } } } }, "/Contract/GetGr1List": { "get": { "summary": "List GR1 registrations", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Contract/UpdateProjectedGrossRevenue": { "put": { "summary": "Update projected gross revenue", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Contract/PostGr1": { "post": { "summary": "Post GR1 form", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/Contract/GetGr1File": { "get": { "summary": "Download GR1 file", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "File download", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Contract/GetGr2List": { "get": { "summary": "List GR2 registrations", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Contract/PostGr2": { "post": { "summary": "Post GR2 form", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/Contract/GetGr2File": { "get": { "summary": "Download GR2 file", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "File download", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Contract/GenerateGrForm": { "post": { "summary": "Generate GR form", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Contract/SendGrForm": { "post": { "summary": "Send GR form email", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/Contract/ScheduleGrFormEmail": { "post": { "summary": "Schedule GR form email", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Contract/CancelGrFormEmail": { "post": { "summary": "Cancel scheduled GR form email", "tags": [ "Contract" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/CycleInvoicing/Retrieve": { "post": { "summary": "Retrieve cycle invoices", "tags": [ "CycleInvoicing" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/CycleInvoicing/Post": { "post": { "summary": "Post selected cycle invoices", "tags": [ "CycleInvoicing" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/CycleInvoicing/CancelEmail": { "post": { "summary": "Cancel cycle invoice email", "tags": [ "CycleInvoicing" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "updatedBy", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/CycleInvoicing/GetInvoiceFile": { "get": { "summary": "Download invoice file", "tags": [ "CycleInvoicing" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "File download", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/CycleInvoicing/GetReceiptFile": { "get": { "summary": "Download receipt file", "tags": [ "CycleInvoicing" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "File download", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Undertaking/Create": { "post": { "summary": "Create undertaking", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Undertaking/GetList": { "get": { "summary": "List undertakings", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } } } }, "/Undertaking/GetListByYear": { "get": { "summary": "List undertakings by year", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "baseYear", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Undertaking/GetById": { "get": { "summary": "Get undertaking by id", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Undertaking/GetBillingPeriods": { "get": { "summary": "Get billing periods", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Undertaking/PreviewBillingPeriods": { "post": { "summary": "Preview billing periods", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Undertaking/UpdateBillingPeriods": { "put": { "summary": "Update billing periods", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Undertaking/Update": { "put": { "summary": "Update undertaking", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Undertaking/Delete": { "delete": { "summary": "Delete undertaking", "tags": [ "Undertaking" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Reconciliation/CheckSurplus": { "post": { "summary": "Check surplus reconciliation", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Reconciliation/ConfirmSurplus": { "post": { "summary": "Confirm surplus reconciliation", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Reconciliation/CheckGr1VsGr2": { "post": { "summary": "Check GR1 vs GR2 reconciliation", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Reconciliation/ConfirmGr1VsGr2": { "post": { "summary": "Confirm GR1 vs GR2 reconciliation", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Reconciliation/CheckRowAndPostal": { "post": { "summary": "Check row and postal reconciliation", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Reconciliation/ConfirmRowAndPostal": { "post": { "summary": "Confirm row and postal reconciliation", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Reconciliation/GetLatest": { "get": { "summary": "Get latest reconciliation run", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "basisYear", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Reconciliation/GetDocumentFile": { "get": { "summary": "Download reconciliation document", "tags": [ "Reconciliation" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "File download", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Reports/reconciliation/{basisYear}/surplus": { "get": { "summary": "Surplus reconciliation report", "tags": [ "Reports" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/Reports/reconciliation/{basisYear}/gr1-vs-gr2": { "get": { "summary": "GR1 vs GR2 reconciliation report", "tags": [ "Reports" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/Reports/reconciliation/{basisYear}/row-and-postal": { "get": { "summary": "Row and postal reconciliation report", "tags": [ "Reports" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "/Reports/licenses/expired": { "get": { "summary": "Expired licenses report", "tags": [ "Reports" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "asOf", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "withinDays", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 } } ] } }, "/Reports/cycle-invoices": { "get": { "summary": "Cycle invoice report", "tags": [ "Reports" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/Reports/cycle-invoices/issued": { "get": { "summary": "Issued documents report", "tags": [ "Reports" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/Reports/cycle-invoices/yearly/{basisYear}": { "get": { "summary": "Yearly invoice report", "tags": [ "Reports" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "basisYear", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "ruleNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/Rule/GetList": { "get": { "summary": "List rules", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/Rule/GetListSummary": { "get": { "summary": "List rule summaries", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } } } }, "/Rule/GetLocalList": { "get": { "summary": "List local rules", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } } } }, "/Rule/SyncCatalog": { "post": { "summary": "Sync Business Central rule catalog", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/Rule/GetById": { "get": { "summary": "Get rule by id", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/Rule/GetByRuleNo": { "get": { "summary": "Get rule by rule number", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "ruleNo", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/Rule/Update": { "put": { "summary": "Update rule", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Rule/CalculatePreview": { "post": { "summary": "Calculate charge preview", "tags": [ "Rule" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Employee/Me": { "get": { "summary": "Get current employee profile", "tags": [ "Employee" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } } } }, "/Employee/Create": { "post": { "summary": "Create employee", "tags": [ "Employee" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Employee/GetList": { "get": { "summary": "List employees", "tags": [ "Employee" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } } } }, "/Employee/Update": { "put": { "summary": "Update employee", "tags": [ "Employee" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Employee/Delete": { "delete": { "summary": "Delete employee", "tags": [ "Employee" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ] } }, "/RolePermission/Add": { "post": { "summary": "Add role permissions", "tags": [ "RolePermission" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/RolePermission/GetList": { "get": { "summary": "List role permissions", "tags": [ "RolePermission" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } } } }, "/RolePermission/GetByRole": { "get": { "summary": "Get permissions by role", "tags": [ "RolePermission" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "parameters": [ { "name": "role", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/RolePermission/Delete": { "delete": { "summary": "Delete role permission", "tags": [ "RolePermission" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/Audit/GetList": { "get": { "summary": "List audit entries", "tags": [ "Audit" ], "security": [ { "Bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "description": "Returns a page of audit rows (50 per request), newest first.", "parameters": [ { "name": "skip", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 } } ] } } }, "components": { "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Enter a valid Entra ID access token." } }, "schemas": { "ApiResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "message": { "type": "string" }, "entity": {}, "error": { "type": "object", "nullable": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } }, "ContractDto": { "type": "object", "additionalProperties": true } } }, "security": [ { "Bearer": [] } ] }