{ "openapi": "3.0.1", "info": { "title": "Wyzio REST API", "termsOfService": "https://www.wyzio.com/terms_of_service/", "contact": { "email": "support@wyzio.com" }, "version": "1.0", "description": "Welcome to Wyzio REST API documention. This document describes the specification of the Wyzio REST API, hereafter referenced as 'the API'. This contains a description of the functionality that is made available by the API, as well as the architectural style it should use and the protocol by which it is offered. When there is room for interpretation in any of these aspects, this document also tries to specify how the API must resolve these ambiguities. We do this to provide a reference document, both to the implementers and the consumers of the API, and to ensure there is a unified interface that all parties must adhere to and can rely on for their own use." }, "servers": [ { "url": "https://wyzio.app", "description": "Generated server url" } ], "paths": { "/api-v1/vacation": { "put": { "tags": [ "vacation-controller" ], "summary": "Create absence", "operationId": "createAbsence", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Absence" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "vacation-controller" ], "summary": "Delete absence", "operationId": "delete_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Absence" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet": { "get": { "tags": [ "timesheet-controller" ], "summary": "Get list of timesheets", "operationId": "getTableView_5", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "put": { "tags": [ "timesheet-controller" ], "summary": "Create timesheet", "operationId": "create", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOtherEmployeeTimeEntry" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/{id}/workflow/{workflowId}": { "put": { "tags": [ "timesheet-controller" ], "summary": "Modify timesheet`s workflow", "operationId": "changeWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "timesheet-controller" ], "summary": "Add timesheet to workflow", "operationId": "addToWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{invoiceId}/payment/{paymentId}/split": { "put": { "tags": [ "sales-invoice-controller" ], "summary": "Split sales invoice payment", "operationId": "splitPayment", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitPayment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{id}/workflow/{workflowId}": { "put": { "tags": [ "sales-invoice-controller" ], "summary": "Modify sales invoice`s workflow", "operationId": "changeWorkflow_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "sales-invoice-controller" ], "summary": "Add sales invoice to workflow", "operationId": "addToWorkflow_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/report-template/batch": { "put": { "tags": [ "report-template-controller" ], "summary": "Modify report template", "operationId": "batchUpdate", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/StaticTemplateLine" }, { "$ref": "#/components/schemas/TemplateLine" } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{invoiceId}/payment/{paymentId}/split": { "put": { "tags": [ "purchase-invoice-controller" ], "summary": "Split purchase invoice payment", "operationId": "splitPayment_1", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitPayment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{id}/workflow/{workflowId}": { "put": { "tags": [ "purchase-invoice-controller" ], "summary": "Modify purchase invoice`s workflow", "operationId": "changeWorkflow_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "purchase-invoice-controller" ], "summary": "Add purchase invoice to workflow", "operationId": "addToWorkflow_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/batch": { "put": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Modify batch of purchase invoice scans", "operationId": "batchUpdate_1", "parameters": [ { "name": "suppressDuplicateWarning", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoiceScan" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pdf-template/global/batch": { "put": { "tags": [ "pdf-template-controller" ], "summary": "Modify batch of admins` PDF templates", "operationId": "updateGlobal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PdfTemplate" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pdf-template/batch": { "put": { "tags": [ "pdf-template-controller" ], "summary": "Modify batch of organization`s PDF templates", "operationId": "update", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PdfTemplate" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/currency-exchange/batch": { "put": { "tags": [ "organization-currency-exchange-controller" ], "summary": "Modify batch of currency exchange rates for organization", "operationId": "batchUpdate_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationCurrencyExchange" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/workflow/{workflowId}": { "put": { "tags": [ "order-controller" ], "summary": "Modify order`s workflow", "operationId": "changeWorkflow_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "order-controller" ], "summary": "Add order to workflow", "operationId": "addToWorkflow_5", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount": { "get": { "tags": [ "my-account-controller" ], "summary": "Get my account info", "operationId": "getMyAccount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyAccount" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "put": { "tags": [ "my-account-controller" ], "summary": "Modify my account", "operationId": "updateMyAccount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyAccount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/document-type": { "put": { "tags": [ "document-controller" ], "summary": "Change document type", "operationId": "changeDocumentType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/batch": { "put": { "tags": [ "document-controller" ], "summary": "Modify batch of documents", "operationId": "batchUpdate_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/currency-exchange/batch": { "put": { "tags": [ "currency-exchange-controller" ], "summary": "Modify batch of currency exchange rates", "operationId": "batchUpdate_4", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyExchange" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts/batch": { "put": { "tags": [ "chart-of-accounts-controller" ], "summary": "Modify batch of chart of accounts", "operationId": "batchUpdate_5", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChartOfAccounts" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/budget/batch": { "put": { "tags": [ "budget-controller" ], "summary": "Modify batch of budgets", "operationId": "batchUpdate_6", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Budget" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/category/batch": { "put": { "tags": [ "article-category-controller" ], "summary": "Modify batch of article categories", "operationId": "batchUpdate_7", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleCategory" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/unlock/{id}": { "put": { "tags": [ "accounting-period-controller" ], "summary": "Unlock an accounting period", "operationId": "unlockAccountingPeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/open/{id}": { "put": { "tags": [ "accounting-period-controller" ], "summary": "Open an accounting period", "operationId": "openAccountingPeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/lock/{id}": { "put": { "tags": [ "accounting-period-controller" ], "summary": "Lock an accounting period", "operationId": "lockAccountingPeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/list-unlock/{id}": { "put": { "tags": [ "accounting-period-controller" ], "summary": "Simple unlock of an accounting period", "operationId": "unlockListAccountingPeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/list-lock/{id}": { "put": { "tags": [ "accounting-period-controller" ], "summary": "Simple lock of an accounting period", "operationId": "lockListAccountingPeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/close/{id}": { "put": { "tags": [ "accounting-period-controller" ], "summary": "Close an accounting period", "operationId": "closeAccountingPeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/workflow/batch": { "post": { "tags": [ "workflow-controller" ], "summary": "Modify batch of user groups", "operationId": "batchUpdate_8", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/widget/batch": { "post": { "tags": [ "widget-controller" ], "summary": "Modify enabled widgets", "operationId": "batchUpdate_9", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Widget" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Widget" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vat/report": { "get": { "tags": [ "vat-controller" ], "summary": "Export VAT report", "operationId": "getReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatReportLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "vat-controller" ], "summary": "Submit VAT Report", "operationId": "submitVatReport", "parameters": [ { "name": "vatReportSubmit", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/VatReportSubmit" } }, { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vat/report/validate": { "post": { "tags": [ "vat-controller" ], "summary": "Validate submitting VAT Report", "operationId": "validateSubmittingVatReport", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/{id}": { "post": { "tags": [ "vacation-controller" ], "summary": "Modify absence", "operationId": "modifyAbsence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Absence" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user/restore-access-code": { "post": { "tags": [ "user-controller" ], "summary": "Restore access code for user", "operationId": "restoreAccessCode", "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user/reactivate": { "post": { "tags": [ "user-controller" ], "summary": "Custom activate user", "operationId": "activateUser", "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "totpkey", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user-group/batch": { "post": { "tags": [ "user-group-controller" ], "summary": "Modify batch of user groups", "operationId": "batchUpdate_10", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/{id}/reject": { "post": { "tags": [ "timesheet-controller" ], "summary": "Reject a timesheet", "operationId": "reject", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/{id}/approve": { "post": { "tags": [ "timesheet-controller" ], "summary": "Approve a timesheet", "operationId": "approve", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/team/review/reject": { "post": { "tags": [ "team-review-controller" ], "summary": "Reject team review timesheets", "operationId": "rejectTeamReview", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/team/review/employee/{employeeContactId}/reject": { "post": { "tags": [ "team-review-controller" ], "summary": "Reject team review timesheets for particular employee", "operationId": "rejectForEmployee", "parameters": [ { "name": "employeeContactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/team/review/employee/{employeeContactId}/approve": { "post": { "tags": [ "team-review-controller" ], "summary": "Approve team review timesheets for particular employee", "operationId": "approveForEmployee", "parameters": [ { "name": "employeeContactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/team/review/approve": { "post": { "tags": [ "team-review-controller" ], "summary": "Approve team review timesheets", "operationId": "approveTeamReview", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/reject": { "post": { "tags": [ "timesheet-controller" ], "summary": "Reject timesheets", "description": "Returns ids of rejected timesheets", "operationId": "reject_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/batch": { "post": { "tags": [ "timesheet-controller" ], "summary": "Modify batch of timsheets", "operationId": "batchUpdate_11", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetDetails" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/batch/reject": { "post": { "tags": [ "timesheet-controller" ], "summary": "Reject batch of timesheets", "description": "Returns the ids of timesheets that have been rejected", "operationId": "batchReject", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/batch/approve": { "post": { "tags": [ "timesheet-controller" ], "summary": "Approve batch of timesheets", "description": "Returns the ids of timesheets that have been approved", "operationId": "batchApprove", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/approve": { "post": { "tags": [ "timesheet-controller" ], "summary": "Approve timesheets", "description": "Returns ids of approved timesheets", "operationId": "approve_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/tag/document": { "get": { "tags": [ "tag-controller" ], "summary": "Get list of tags", "operationId": "getDocumentTags", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTagEntity" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "tag-controller" ], "summary": "Create new tag", "operationId": "createDocumentTag", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/tag/contact": { "get": { "tags": [ "tag-controller" ], "summary": "Get list of tags", "operationId": "getContactTags", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTagEntity" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "tag-controller" ], "summary": "Create new tag", "operationId": "createContactTag", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/{subOrderId}/generate-sales-invoice": { "post": { "tags": [ "sub-order-controller" ], "summary": "Generate sales invoice from sub-order", "operationId": "generateSalesInvoices", "parameters": [ { "name": "subOrderId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceUserValidatedView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/{subOrderId}/generate-pro-forma": { "post": { "tags": [ "sub-order-controller" ], "summary": "Generate pro-forma sales invoice from sub-order", "operationId": "generateProFormaSalesInvoice", "parameters": [ { "name": "subOrderId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "invoicingDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/regenerate": { "post": { "tags": [ "sub-order-controller" ], "summary": "Regenerate sub-orders", "operationId": "regenerateSubOrders", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/generate-sales-invoices": { "post": { "tags": [ "sub-order-controller" ], "summary": "Generate sales invoices from sub-orders", "operationId": "generateSalesInvoices_1", "parameters": [ { "name": "subOrderIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "invoicingDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/fixprepayments": { "post": { "tags": [ "sub-order-controller" ], "summary": "Fix unlinked pre-payments", "operationId": "fixingUnlinkedPrepayments", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-movement-line/batch": { "post": { "tags": [ "stock-movement-line-controller" ], "summary": "Modify batch of stock movements", "operationId": "batchUpdate_12", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StockMovementLine" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{invoiceId}/send-by-email": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Send sales invoice to its client by email as pdf", "operationId": "sendByEmail", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{invoiceId}/delivery-note/send-by-email": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Send delivery note by email as pdf", "operationId": "sendDeliveryNoteByEmail", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/workflow": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Add sales invoices to workflows", "operationId": "addToWorkflow_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/send-by-email": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Send sales invoices to clients by email as pdfs", "operationId": "sendInvoicesByEmail", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/delivery-note/send-by-email": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Send delivery notes by email as pdfs", "operationId": "sendDeliveryNotesByEmail", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/batch": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Modify batch of sales invoices", "operationId": "batchUpdate_13", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoice" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/batch/validate": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Validate batch of sales invoices", "operationId": "batchValidate", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "patch": { "tags": [ "sales-invoice-controller" ], "summary": "Validate batch of sales invoices", "operationId": "batchValidate_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/attach-invoice-lines-to-shipments": { "post": { "tags": [ "sales-invoice-controller" ], "summary": "Attach invoice lines to shipments", "operationId": "attachInvoiceLinesToShipments", "parameters": [ { "name": "salesInvoiceId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/role/batch": { "post": { "tags": [ "role-controller" ], "summary": "Modify batch of roles and super-roles", "operationId": "batchUpdate_14", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/RoleWithPermissions" }, { "$ref": "#/components/schemas/SuperRole" } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/report-template/clean-budget-entries": { "post": { "tags": [ "report-template-controller" ], "summary": "Clean budget entries", "operationId": "cleanBudgetEntries", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/reconciliation-lines/upload": { "post": { "tags": [ "reconciliation-controller" ], "summary": "Upload reconciliation file", "description": "Returns a map {numberOfEntitiesGenerated, numberOfEntitiesGenerated}", "operationId": "uploadFile", "parameters": [ { "name": "file", "in": "query", "description": "Uploaded file", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationUploadResult" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/reconciliation-lines/reconcile": { "post": { "tags": [ "reconciliation-controller" ], "summary": "Reconciliation for lines", "operationId": "reconcile", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/reconciliation-lines/batch": { "post": { "tags": [ "reconciliation-controller" ], "summary": "Modify batch of reconciliation lines", "operationId": "batchUpdate_15", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationLine" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/qrcode/instructions/{contactId}": { "post": { "tags": [ "qr-code-controller" ], "summary": "Send qr code instructions to user", "operationId": "sendQrCodeInstructions", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/workflow": { "post": { "tags": [ "purchase-invoice-controller" ], "summary": "Add purchase invoices to workflows", "operationId": "addToWorkflow_4", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/batch": { "post": { "tags": [ "purchase-invoice-controller" ], "summary": "Modify batch of purchase invoices", "operationId": "batchUpdate_16", "parameters": [ { "name": "suppressDuplicateWarning", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoice" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/batch/validate": { "post": { "tags": [ "purchase-invoice-controller" ], "summary": "Validate batch of purchase invoices", "operationId": "batchValidate_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "patch": { "tags": [ "purchase-invoice-controller" ], "summary": "Validate batch of purchase invoices", "operationId": "batchValidate_4", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/upload": { "post": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Upload purchase invoice scan files", "operationId": "upload", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/{id}/copy-with-children": { "post": { "tags": [ "payslip-controller" ], "summary": "Copy with children configuration", "operationId": "copyWithRegions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopySalaryConfigurationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/upload-source-tax-rates/{calendarYear}": { "post": { "tags": [ "payslip-controller" ], "summary": "Upload Source Tax Rates file", "operationId": "uploadFile_1", "parameters": [ { "name": "calendarYear", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "file", "in": "query", "description": "Uploaded file", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/batch": { "post": { "tags": [ "payslip-controller" ], "summary": "Modify batch of salary configs", "operationId": "batchUpdate_17", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payslip" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/{id}/send-by-email": { "post": { "tags": [ "payroll-controller" ], "summary": "Send payslip to its employee by email as pdf", "operationId": "sendByEmail_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/send-by-email": { "post": { "tags": [ "payroll-controller" ], "summary": "Send payslips to employees by email as pdfs", "operationId": "sendPayrollsByEmail", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/generate": { "post": { "tags": [ "payroll-controller" ], "summary": "Generate payrolls", "operationId": "generatePayrolls", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSalariesInfo" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/batch": { "post": { "tags": [ "payroll-controller" ], "summary": "Modify batch of payrolls", "operationId": "batchUpdate_18", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/batch/payments": { "post": { "tags": [ "payroll-controller" ], "summary": "Modify batch of payrolls payments", "operationId": "batchUpdatePayrollsPayments", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollPayment" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/payment-dates": { "post": { "tags": [ "payable-controller" ], "summary": "Modify dates for batch of payments", "operationId": "updatePaymentDates", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payable" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayableView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/pain001": { "post": { "tags": [ "payable-controller" ], "summary": "Generate pain001 file(s)", "description": "Return value: if isConfidential is true and paymentsForGeneration are of several modules - [{fileName, xmlAsBytes}, {fileName, xmlAsBytes}] (where one of the files is confidential on the bank statement), otherwise xml file as byte[]", "operationId": "generate", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pain001GenerationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization": { "get": { "tags": [ "organization-controller" ], "summary": "Get list of organizations", "operationId": "getOrganizations", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "organization-controller" ], "summary": "Create new organization based on other organization or template", "operationId": "create_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "newOrganization": { "$ref": "#/components/schemas/NewOrganization" }, "user": { "$ref": "#/components/schemas/WealUserDetails" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/switch/{id}": { "get": { "tags": [ "organization-controller" ], "summary": "Get list of organizations to switch for contact", "operationId": "getOrganizationsForSwitchListByContactId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "organization-controller" ], "summary": "Change currently selected organization", "operationId": "switchOrganizations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/batch": { "post": { "tags": [ "organization-controller" ], "summary": "Modify batch of organizations", "operationId": "batchUpdate_19", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StandaloneOrganizationDetails" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{orderId}/send-by-email": { "post": { "tags": [ "order-controller" ], "summary": "Send order to its contact by email as pdf", "operationId": "sendByEmail_2", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{orderId}/delivery-note/send-by-email": { "post": { "tags": [ "order-controller" ], "summary": "Send delivery note by email as pdf", "operationId": "sendDeliveryNoteByEmail_1", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/update-prices": { "post": { "tags": [ "order-controller" ], "summary": "Update order elements prices in accordance with contact article discounts", "operationId": "updatePrices", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/pre-pay": { "post": { "tags": [ "order-controller" ], "summary": "Pre-pay order", "operationId": "prePay", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrePayment" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/partial-pay": { "post": { "tags": [ "order-controller" ], "summary": "Partial pay order", "operationId": "partialPay", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialPayment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/workflow": { "post": { "tags": [ "order-controller" ], "summary": "Add orders to workflows", "operationId": "addToWorkflow_6", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/send-by-email": { "post": { "tags": [ "order-controller" ], "summary": "Send orders to clients by email as pdfs", "operationId": "sendInvoicesByEmail_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/delivery-note/send-by-email": { "post": { "tags": [ "order-controller" ], "summary": "Send delivery notes by email as pdfs", "operationId": "sendDeliveryNotesByEmail_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/create-status-history": { "post": { "tags": [ "order-controller" ], "summary": "Create order status history", "operationId": "createStatusHistory", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/batch": { "post": { "tags": [ "order-controller" ], "summary": "Modify batch of orders", "operationId": "batchUpdate_20", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/batch/validate": { "post": { "tags": [ "order-controller" ], "summary": "Validate batch of orders", "operationId": "batchValidate_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "patch": { "tags": [ "order-controller" ], "summary": "Validate batch of orders", "operationId": "batchValidate_5", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/pdf-password": { "post": { "tags": [ "my-account-controller" ], "summary": "Change the password of the salary pdf file for employees", "operationId": "changeSalarySlipPdfPasswordForStaff", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/password": { "post": { "tags": [ "my-account-controller" ], "summary": "Change my password", "operationId": "changePassword", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordMyAccount" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet": { "post": { "tags": [ "my-timesheet-controller" ], "summary": "Modify my timesheet", "operationId": "update_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/{id}/stop": { "post": { "tags": [ "my-timesheet-controller" ], "summary": "Stop my timesheet", "operationId": "stopTimer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/{id}/start": { "post": { "tags": [ "my-timesheet-controller" ], "summary": "Start my timesheet", "operationId": "startTimer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/submit": { "post": { "tags": [ "my-timesheet-controller" ], "summary": "Submit my timesheets of the current user", "operationId": "submitForApproval", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/submit-for-approval": { "post": { "tags": [ "my-expenses-controller" ], "summary": "Submit expenses for approval by filter", "operationId": "submitForApproval_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/generate-expense-invoice": { "post": { "tags": [ "my-expenses-controller" ], "summary": "Generate expense invoice by filter params", "operationId": "generateExpenseInvoice", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/batch": { "post": { "tags": [ "my-expenses-controller" ], "summary": "Modify batch of expenses", "operationId": "batchUpdate_21", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/batch/submit-for-approval": { "post": { "tags": [ "my-expenses-controller" ], "summary": "Submit expenses for approval", "operationId": "submitForApproval_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/batch/generate-expense-invoice": { "post": { "tags": [ "my-expenses-controller" ], "summary": "Generate expense invoice by expenses ids", "operationId": "generateExpenseInvoiceBatch", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/mail-server/test-connection": { "post": { "tags": [ "mail-server-controller" ], "summary": "Test mail server config (basic auth or OAuth2)", "operationId": "testMailServerConnection", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailServerConfig" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/mail-server/oauth2/revoke/{mailServerConfigId}": { "post": { "tags": [ "mail-server-controller" ], "summary": "Revoke OAuth2 tokens for a mail server config", "operationId": "revokeOAuth", "parameters": [ { "name": "mailServerConfigId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/mail-server/oauth2/consent-url": { "post": { "tags": [ "mail-server-controller" ], "summary": "Get the OAuth2 provider consent URL for a mail account", "operationId": "getOAuthConsentUrl", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthInitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthConsentUrlResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/mail-server/oauth2/callback": { "post": { "tags": [ "mail-server-controller" ], "summary": "Complete OAuth2 setup by exchanging the authorization code for tokens", "operationId": "handleOAuthCallback", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthCallbackRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/late-notice/send-by-email": { "post": { "tags": [ "late-notice-controller" ], "summary": "Send late notices to its client by email as pdf", "operationId": "sendByEmail_3", "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "REMINDER", "STATEMENT" ] } }, { "name": "clientContactId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "salesPaymentId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal/import": { "post": { "tags": [ "journal-controller" ], "summary": "Import journal entries", "operationId": "importContent", "parameters": [ { "name": "file", "in": "query", "description": "Uploaded file", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalImportFileDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntry" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal/batch": { "post": { "tags": [ "journal-controller" ], "summary": "Modify batch of journal entries", "operationId": "batchUpdate_22", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntry" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/invoice-scan-recognizer/recognize": { "post": { "tags": [ "invoice-scan-recognizer-controller" ], "summary": "Recognize a bunch of documents", "operationId": "recognize", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/invoice-scan-recognizer/recognize/{documentFileId}": { "post": { "tags": [ "invoice-scan-recognizer-controller" ], "summary": "Recognize a document by Id", "operationId": "recognize_1", "parameters": [ { "name": "documentFileId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/global/role/batch": { "post": { "tags": [ "global-role-controller" ], "summary": "Modify batch of roles and super-roles", "operationId": "batchUpdate_23", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/RoleWithPermissions" }, { "$ref": "#/components/schemas/SuperRole" } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/reject": { "post": { "tags": [ "expenses-controller" ], "summary": "Reject an expenses by filter", "operationId": "reject_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/generate-expense-invoice": { "post": { "tags": [ "expenses-controller" ], "summary": "Generate expense invoice by filter params", "operationId": "generateExpenseInvoice_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/upload": { "post": { "tags": [ "expenses-draft-controller" ], "operationId": "uploadFile_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/draft-to-final": { "post": { "tags": [ "expenses-draft-controller" ], "summary": "Modify draft expenses to final expenses", "operationId": "modifyToFinal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/batch": { "post": { "tags": [ "expenses-draft-controller" ], "summary": "Modify batch of draft expenses", "operationId": "batchUpdate_24", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseDraft" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/batch": { "post": { "tags": [ "expenses-controller" ], "summary": "Modify batch of expenses", "operationId": "batchUpdate_25", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/batch/reject": { "post": { "tags": [ "expenses-controller" ], "summary": "Reject an expenses", "operationId": "reject_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/batch/approve": { "post": { "tags": [ "expenses-controller" ], "summary": "Approve an expenses", "operationId": "approve_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/approve": { "post": { "tags": [ "expenses-controller" ], "summary": "Approve an expenses by filter", "operationId": "approve_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/upload": { "post": { "tags": [ "document-controller" ], "summary": "Upload document file", "operationId": "uploadFile_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/upload-archive": { "post": { "tags": [ "document-controller" ], "summary": "Upload document files archive", "operationId": "uploadArchive", "parameters": [ { "name": "isPdfTemplate", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document-scan/{id}/assign-to-pis": { "post": { "tags": [ "document-scan-controller" ], "summary": "Assign document scan to purchase invoice scan", "operationId": "assignToPurchaseInvoiceScan", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/department/tree": { "get": { "tags": [ "department-controller" ], "summary": "Get list of departments", "operationId": "getDepartmentTree_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "department-controller" ], "summary": "Modify departments", "operationId": "updateDepartments", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/currency-exchange/apply": { "get": { "tags": [ "currency-exchange-controller" ], "summary": "Apply exchange rate for particular currencies and date combination", "operationId": "applyRate", "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "amount", "in": "query", "required": true, "schema": { "type": "number" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "currency-exchange-controller" ], "summary": "Apply exchange rate for list of combinations", "operationId": "convert", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}/modify/main-user": { "post": { "tags": [ "contact-controller" ], "summary": "Modify main user", "operationId": "batchUpdate_26", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MainUser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{contactId}/send-pdf-password": { "post": { "tags": [ "contact-controller" ], "summary": "Resend the password of the salary pdf file for employees", "operationId": "resendPdfPasswordForStaff", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{contactId}/pdf-password": { "post": { "tags": [ "contact-controller" ], "summary": "Change the password of the salary pdf file for employees", "operationId": "changePdfPasswordForStaff", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/upload-vCard": { "post": { "tags": [ "contact-controller" ], "summary": "Upload VCard file", "operationId": "uploadVCard", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/password": { "post": { "tags": [ "contact-controller" ], "summary": "Change password of user", "operationId": "changePasswordForContact", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordForContact" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/merging": { "post": { "tags": [ "contact-controller" ], "summary": "Merging two contacts and delete related one", "operationId": "postMergeContact", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/batch": { "post": { "tags": [ "contact-controller" ], "summary": "Modify batch of contacts", "operationId": "batchUpdate_27", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Contact" }, { "$ref": "#/components/schemas/OrganizationContact" }, { "$ref": "#/components/schemas/PersonContact" } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/consolidated-organization": { "post": { "tags": [ "consolidated-organization-controller" ], "summary": "Create new consolidate organization", "operationId": "create_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "newOrganization": { "$ref": "#/components/schemas/NewConsolidatedOrganization" }, "user": { "$ref": "#/components/schemas/WealUserDetails" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/budget/upload": { "post": { "tags": [ "budget-controller" ], "summary": "Import details of budget", "operationId": "importBudget", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BudgetImportFileDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/pay": { "post": { "tags": [ "billing-controller" ], "summary": "Pay opened amount", "operationId": "pay", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/pay-result": { "post": { "tags": [ "billing-controller" ], "summary": "Process payment result for the user", "operationId": "processPaymentResult", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentResult" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/billing-plan": { "get": { "tags": [ "billing-controller" ], "summary": "Get billing plan", "operationId": "getBillingPlan", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingPlanView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "post": { "tags": [ "billing-controller" ], "summary": "Modify batch of billing plans", "operationId": "batch", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingPlan" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/adjust-and-pay": { "post": { "tags": [ "billing-controller" ], "summary": "Modify batch of billing plans and pay", "operationId": "adjustUnitsAndPay", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustUnitsPaymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/attachment/upload-avatar/{contactId}": { "post": { "tags": [ "attachment-controller" ], "summary": "Upload new avatar", "operationId": "upload_1", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "note", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentEntity" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/batch": { "post": { "tags": [ "article-controller" ], "summary": "Modify batch of articles", "operationId": "articleBatchUpdate", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Article" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/allocations/batch": { "post": { "tags": [ "allocation-controller" ], "summary": "Modify batch of allocations rules", "operationId": "batchUpdate_28", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationRule" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/batch": { "post": { "tags": [ "accounting-period-controller" ], "summary": "Modify batch of accounting periods", "operationId": "batchUpdate_29", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingPeriod" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{invoiceId}/payment/{paymentId}/value-date": { "patch": { "tags": [ "sales-invoice-controller" ], "summary": "Set value date for payment of sales invoice", "operationId": "updateValueDate", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{invoiceId}/payment/{paymentId}/requested-date": { "patch": { "tags": [ "sales-invoice-controller" ], "summary": "Set requested date for payment of sales invoice", "operationId": "updateRequestedDate", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{invoiceId}/payment/{paymentId}/payment-method": { "patch": { "tags": [ "sales-invoice-controller" ], "summary": "Set payment method for payment of sales invoice", "operationId": "updatePaymentMethod", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartOfAccounts" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{id}/validate": { "patch": { "tags": [ "sales-invoice-controller" ], "summary": "Validate sales invoice", "operationId": "validate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{id}/invalidate": { "patch": { "tags": [ "sales-invoice-controller" ], "summary": "Invalidate sales invoice", "operationId": "invalidate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{id}/convert-pro-forma": { "patch": { "tags": [ "sales-invoice-controller" ], "summary": "Convert pro-forma invoice to regular invoice", "operationId": "convertProforma", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{invoiceId}/payment/{paymentId}/value-date": { "patch": { "tags": [ "purchase-invoice-controller" ], "summary": "Set value date for payment of purchase invoice", "operationId": "updateValueDate_1", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{invoiceId}/payment/{paymentId}/requested-date": { "patch": { "tags": [ "purchase-invoice-controller" ], "summary": "Set requested date for payment of purchase invoice", "operationId": "updateRequestedDate_1", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{invoiceId}/payment/{paymentId}/payment-method": { "patch": { "tags": [ "purchase-invoice-controller" ], "summary": "Set payment method for payment of purchase invoice", "operationId": "updatePaymentMethod_1", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartOfAccounts" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{id}/validate": { "patch": { "tags": [ "purchase-invoice-controller" ], "summary": "Validate purchase invoice", "operationId": "validate_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{id}/refused": { "patch": { "tags": [ "purchase-invoice-controller" ], "summary": "Refused from purchase invoice", "operationId": "refused", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{id}/invalidate": { "patch": { "tags": [ "purchase-invoice-controller" ], "summary": "Invalidate purchase invoice", "operationId": "invalidate_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/{id}/validate": { "patch": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Validate purchase invoice scan", "operationId": "validate_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/{id}/invalidate": { "patch": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Invalidate purchase invoice scan", "operationId": "invalidate_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/{invoiceId}/payment/{paymentId}/value-date": { "patch": { "tags": [ "payroll-controller" ], "summary": "Set value date for payment of payroll", "operationId": "updateValueDate_2", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/update": { "patch": { "tags": [ "payroll-controller" ], "summary": "Update payrolls", "operationId": "updatePayrolls", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/update/{id}": { "patch": { "tags": [ "payroll-controller" ], "summary": "Update payroll", "operationId": "updatePayroll", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/adjust": { "patch": { "tags": [ "payroll-controller" ], "summary": "Generate adjustment line for payrolls", "operationId": "adjust", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/adjust/{id}": { "patch": { "tags": [ "payroll-controller" ], "summary": "Generate adjustment line for payrolls by id", "operationId": "adjustById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/accounting/payment": { "patch": { "tags": [ "payroll-controller" ], "summary": "Update payment accounting for list of payrolls", "operationId": "updatePaymentAccounting", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/accounting/payment/{id}": { "patch": { "tags": [ "payroll-controller" ], "summary": "Update payment accounting for payroll", "operationId": "updatePaymentAccounting_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/accounting/emission": { "patch": { "tags": [ "payroll-controller" ], "summary": "Update emission accounting for list of payrolls", "operationId": "updateEmissionAccounting", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/accounting/emission/{payrollId}": { "patch": { "tags": [ "payroll-controller" ], "summary": "Update emission accounting for payroll", "operationId": "updateEmissionAccounting_1", "parameters": [ { "name": "payrollId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payment/batch": { "patch": { "tags": [ "payment-controller" ], "summary": "Modify batch of payments", "operationId": "batchUpdate_30", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/validate": { "patch": { "tags": [ "order-controller" ], "summary": "Validate order", "operationId": "validate_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/invalidate": { "patch": { "tags": [ "order-controller" ], "summary": "Invalidate order", "operationId": "invalidate_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/confirmed": { "patch": { "tags": [ "order-controller" ], "summary": "Set order status confirmed", "operationId": "setConfirmed", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/billable": { "patch": { "tags": [ "order-controller" ], "summary": "Set order status billable", "operationId": "setBillable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal/line": { "patch": { "tags": [ "journal-controller" ], "summary": "Update exchange rates in journal line", "operationId": "updateWithExchangeRate", "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "companyCurrencyId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalLine" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalLine" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/{id}/self/{flag}": { "patch": { "tags": [ "document-controller" ], "summary": "Set flagged or un flagged value of the \"self\" flag for the staff document.", "operationId": "self", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "flag", "in": "path", "required": true, "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/payment-info": { "get": { "tags": [ "billing-controller" ], "summary": "Get payment info for the user", "operationId": "getPaymentInfo", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentInfo" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "billing-controller" ], "summary": "Delete payment info for the user", "operationId": "deletePaymentInfo", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "patch": { "tags": [ "billing-controller" ], "summary": "Modify payment info for the user", "operationId": "modifyPaymentInfo", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/workflow": { "get": { "tags": [ "workflow-controller" ], "summary": "Get list of user groups", "operationId": "getTableView", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/workflow/{id}": { "get": { "tags": [ "workflow-controller" ], "summary": "Get details of user group", "operationId": "find", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "workflow-controller" ], "summary": "Delete user group", "operationId": "delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/workflow/overall": { "get": { "tags": [ "workflow-controller" ], "summary": "Get total results count for list of user groups", "operationId": "calculateResultCount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/widget": { "get": { "tags": [ "widget-controller" ], "summary": "Get enabled widgets", "operationId": "findAllWidgets", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Widget" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/wcr": { "get": { "tags": [ "working-capital-requirement-controller" ], "summary": "Get working capital requirement", "operationId": "getWorkingCapitalRequirement", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "previousPeriodStartDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "previousPeriodEndDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ratio" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vat/preview": { "get": { "tags": [ "vat-controller" ], "summary": "Export VAT report preview", "operationId": "getVatPreview", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VatPreview" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vat/export/xml": { "get": { "tags": [ "vat-controller" ], "summary": "Export VAT report as XML", "operationId": "getXmlExport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/{type}": { "get": { "tags": [ "vacation-controller" ], "summary": "Get list of vacation reports", "operationId": "getTableView_1", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "YEAR", "MONTH" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/VacationBaseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/{type}/total": { "get": { "tags": [ "vacation-controller" ], "summary": "Get total values for list of vacation reports", "operationId": "calculateTotal", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "YEAR", "MONTH" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VacationBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/{type}/report": { "get": { "tags": [ "vacation-controller" ], "summary": "Absence management report", "operationId": "getReport_1", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "YEAR", "MONTH" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/{type}/overall": { "get": { "tags": [ "vacation-controller" ], "summary": "Get total results count for list of vacation reports", "operationId": "calculateResultCount_1", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "YEAR", "MONTH" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/update-all-vacation-rights": { "get": { "tags": [ "vacation-controller" ], "summary": "Update all vacation rights", "operationId": "updateAllVacationRights", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/provision-unused": { "get": { "tags": [ "vacation-controller" ], "operationId": "manuallyProvisionUnusedVacation", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/holiday": { "get": { "tags": [ "vacation-controller" ], "summary": "Get holidays", "operationId": "getHolidays", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "date-time" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/available-balance": { "get": { "tags": [ "vacation-controller" ], "summary": "Get available balance for the employee", "operationId": "getAvailableBalance", "parameters": [ { "name": "employeeId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "calendarYear", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/vacation/availability": { "get": { "tags": [ "vacation-controller" ], "summary": "Get employees salary periods", "operationId": "getAvailability", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VacationAvailability" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user-group": { "get": { "tags": [ "user-group-controller" ], "summary": "Get list of user groups", "operationId": "getTableView_2", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user-group/{id}": { "get": { "tags": [ "user-group-controller" ], "summary": "Get details of user group", "operationId": "find_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "user-group-controller" ], "summary": "Delete user group", "operationId": "delete_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user-group/users": { "get": { "tags": [ "user-group-controller" ], "summary": "Get user ids according to rule", "operationId": "evaluateRule", "parameters": [ { "name": "rule", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user-group/overall": { "get": { "tags": [ "user-group-controller" ], "summary": "Get total results count for list of user groups", "operationId": "calculateResultCount_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user-group/advanced": { "get": { "tags": [ "user-group-advanced-controller" ], "summary": "Get list of advanced user groups", "operationId": "getTableView_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupAdvancedView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/user-group/advanced/overall": { "get": { "tags": [ "user-group-advanced-controller" ], "summary": "Get total results count for list of advanced user groups", "operationId": "calculateResultCount_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/treasury": { "get": { "tags": [ "treasury-controller" ], "summary": "Get treasury widget", "operationId": "getTreasuryInfo", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreasuryInfo" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/trash-can": { "get": { "tags": [ "trash-can-controller" ], "summary": "Get list of removed entities", "operationId": "getTableView_4", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrashCanView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/trash-can/{id}/restore": { "get": { "tags": [ "trash-can-controller" ], "summary": "Restore removed entity by trash can id", "operationId": "restore", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/{id}": { "get": { "tags": [ "timesheet-controller" ], "summary": "Get details of timesheet", "operationId": "find_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "timesheet-controller" ], "summary": "Delete timesheet", "operationId": "deleteTimesheet", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/total": { "get": { "tags": [ "timesheet-controller" ], "summary": "Get total for list of timesheets", "operationId": "calculateTotal_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimesheetView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/team/review": { "get": { "tags": [ "team-review-controller" ], "summary": "Get team review", "operationId": "getTeamReview", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "employeeNameDirection", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamReview" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/team/review/employee/{employeeContactId}": { "get": { "tags": [ "team-review-controller" ], "summary": "Get team review by employee", "operationId": "getTeamReviewForEmployee", "parameters": [ { "name": "employeeContactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "dateDirection", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeTeamReview" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/team/review/employee/{employeeContactId}/capacity/total": { "get": { "tags": [ "team-review-controller" ], "summary": "Get team review capacity total by employee", "operationId": "getTeamReviewCapacityTotalForEmployee", "parameters": [ { "name": "employeeContactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/task": { "get": { "tags": [ "timesheet-controller" ], "summary": "Get list of tasks", "description": "Returns a map {id, name}", "operationId": "getOrganizationTasks", "parameters": [ { "name": "archived", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/overall": { "get": { "tags": [ "timesheet-controller" ], "summary": "Get total results count for list of timesheets", "operationId": "calculateResultCount_4", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/order": { "get": { "tags": [ "timesheet-controller" ], "summary": "Get list of timesheet orders", "description": "Returns a map {orderId, name}", "operationId": "getTimesheetOrders", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderForTimesheet" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/filter": { "get": { "tags": [ "timesheet-controller" ], "summary": "Get timesheet filter options", "operationId": "getTimesheetFilter", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimesheetFilter" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/advanced": { "get": { "tags": [ "timesheet-advanced-controller" ], "summary": "Get list of timesheets using advanced filtering", "operationId": "getTimesheetsAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetAdvancedView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/advanced/total": { "get": { "tags": [ "timesheet-advanced-controller" ], "summary": "Get total for list of timesheets", "operationId": "calculateTotal_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimesheetAdvancedView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/advanced/overall": { "get": { "tags": [ "timesheet-advanced-controller" ], "summary": "Get total results count for list of timesheets", "operationId": "calculateResultCount_5", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/tag/individual": { "get": { "tags": [ "tag-controller" ], "summary": "Get list of individual tags", "operationId": "getIndividualTags", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndividualTagEntity" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/super-role/{id}": { "get": { "tags": [ "role-controller" ], "summary": "Get details of super-role", "operationId": "findSuperRoleById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuperRole" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders": { "get": { "tags": [ "sub-order-controller" ], "summary": "Get list of sub-orders", "operationId": "getTableView_6", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubOrderView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/total": { "get": { "tags": [ "sub-order-controller" ], "summary": "Get total values for list of sub-orders", "operationId": "getTotals", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubOrderView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/overall": { "get": { "tags": [ "sub-order-controller" ], "summary": "Get total results count for list of order ready to invoice", "operationId": "calculateResultCount_6", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sub-orders/generate": { "get": { "tags": [ "sub-order-controller" ], "summary": "Regenerate one sub-order by reference", "operationId": "generateSubOrder", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-report": { "get": { "tags": [ "stock-report-controller" ], "summary": "Get stock report", "operationId": "getTableView_7", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StockReportLineView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-report/total": { "get": { "tags": [ "stock-report-controller" ], "summary": "Get total values for stock report", "operationId": "getTotals_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockReportLineView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-report/overall": { "get": { "tags": [ "stock-report-controller" ], "summary": "Get total results count for list of articles", "operationId": "calculateResultCount_7", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-movement-line": { "get": { "tags": [ "stock-movement-line-controller" ], "summary": "Get list of stock movements", "operationId": "getTableView_8", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StockMovementLineView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-movement-line/{id}": { "get": { "tags": [ "stock-movement-line-controller" ], "summary": "Get details of stock movement", "operationId": "find_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "stock-movement-line-controller" ], "summary": "Delete stock movement", "operationId": "delete_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-movement-line/total": { "get": { "tags": [ "stock-movement-line-controller" ], "summary": "Get total values for list of stock movement line", "operationId": "calculateTotal_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockMovementLineAdvancedView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-movement-line/overall": { "get": { "tags": [ "stock-movement-line-controller" ], "summary": "Get total results count for list of stock movement lines", "operationId": "calculateResultCount_8", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/stock-movement-line/advanced": { "get": { "tags": [ "stock-movement-line-controller" ], "summary": "Get list of stock movements using advanced filters", "operationId": "getStockMovementLinesAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StockMovementLineView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get list of sales invoices", "operationId": "getTableView_9", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{id}": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get details of sales invoice", "operationId": "find_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoice" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "sales-invoice-controller" ], "summary": "Delete sales invoice", "operationId": "delete_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{id}/deleted": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get details of deleted sales invoice", "operationId": "findOne", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedSalesInvoice" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/total": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get total values for list of sales invoices", "operationId": "calculateTotal_4", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/overall": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get total results count for list of sales invoices", "operationId": "calculateResultCount_9", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/modified-sales-invoice": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get modified sales invoice list", "operationId": "modifiedSalesInvoice", "parameters": [ { "name": "cutoffDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timezoneName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/client": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get list of sales invoices clients", "operationId": "getSalesInvoicesClients", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/advanced": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get list of sales invoices using advanced filters", "operationId": "getAdvancedFilters", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceBaseAdvancedView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/advanced/total": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get total values for list of sales invoices using advanced filters", "operationId": "calculateAdvancedTotal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceBaseAdvancedView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/accounting/{id}": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get accounting entries of sales invoice", "operationId": "getAccount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAccounting" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/accounting/{id}/deleted": { "get": { "tags": [ "sales-invoice-controller" ], "summary": "Get deleted accounting entries of sales invoice", "operationId": "getDeletedAccount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAccounting" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/role": { "get": { "tags": [ "role-controller" ], "summary": "Get list of roles", "operationId": "getTableView_10", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/role/{id}": { "get": { "tags": [ "role-controller" ], "summary": "Get details of role", "operationId": "findRoleById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleWithPermissions" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "role-controller" ], "summary": "Delete role or super-role", "operationId": "delete_5", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/role/permissions": { "get": { "tags": [ "role-controller" ], "summary": "Get permissions of list of roles", "operationId": "findPermissionsByRoleIds", "parameters": [ { "name": "roleIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/report-template/tree": { "get": { "tags": [ "report-template-controller" ], "summary": "Get list of report template lines", "operationId": "getReportTemplate", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "CASH_FLOW", "RATIOS" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/StaticTemplateLine" }, { "$ref": "#/components/schemas/TemplateLine" } ] } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/registry/{uid}": { "get": { "tags": [ "registry-controller" ], "summary": "Get registry by uid", "operationId": "getRegistryByUid", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/registry/{organizationId}/organization": { "get": { "tags": [ "registry-controller" ], "summary": "Get registry by organization id", "operationId": "getRegistryByOrganizationId", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRegistry" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/registry/registry-of-commerce": { "get": { "tags": [ "registry-controller" ], "operationId": "publicationOnContactsOfTheCompany", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryOfCommerce" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/registry/publication": { "get": { "tags": [ "registry-controller" ], "summary": "Get list of registry publication", "operationId": "getTableView_11", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/registry/publication/overall": { "get": { "tags": [ "registry-controller" ], "summary": "Get total results count for list of registry publication", "operationId": "calculateResultCount_10", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/reconciliation-lines": { "get": { "tags": [ "reconciliation-controller" ], "summary": "Get list of reconciliation lines", "operationId": "getTable", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationLineView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "reconciliation-controller" ], "summary": "Delete multiple reconciliation lines", "operationId": "deleteAll", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/reconciliation-lines/{id}": { "get": { "tags": [ "reconciliation-controller" ], "summary": "Get details of order", "operationId": "getReconciliationLine", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconciliationLine" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "reconciliation-controller" ], "summary": "Delete reconciliation line", "operationId": "delete_6", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/reconciliation-lines/to-be-reconciled": { "get": { "tags": [ "reconciliation-controller" ], "summary": "Showing the number of lines to be reconciled.", "operationId": "linesToBeReconciled", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/reconciliation-lines/overall": { "get": { "tags": [ "reconciliation-controller" ], "summary": "Get total results count for list of reconciliation line", "operationId": "calculateResultCount_11", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/receivable": { "get": { "tags": [ "receivable-controller" ], "summary": "Get list of receivables", "operationId": "getTableView_12", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/receivable/total": { "get": { "tags": [ "receivable-controller" ], "summary": "Get total values for list of receivables", "operationId": "calculateTotal_5", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivableView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/receivable/overall": { "get": { "tags": [ "receivable-controller" ], "summary": "Get total results count for list of receivables", "operationId": "calculateResultCount_12", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/receivable/outstanding": { "get": { "tags": [ "receivable-controller" ], "summary": "Get list of outstanding receivables", "operationId": "getOutstandingReceivables", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceContactInfo" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/receivable/outstanding/requested-payment-terms": { "get": { "tags": [ "receivable-controller" ], "summary": "Get details of requested payment terms for outstanding receivables", "operationId": "getRequestedPaymentTerms", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/receivable/filters": { "get": { "tags": [ "receivable-controller" ], "summary": "Prepare filters for get list of receivables", "operationId": "prepareFilters", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/receivable/contact": { "get": { "tags": [ "receivable-controller" ], "summary": "Get list of contacts related to receivables", "operationId": "getContacts", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/ratios-report": { "get": { "tags": [ "ratios-controller" ], "summary": "Get industry average ratios", "operationId": "getRatiosReport", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastYear", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "lastYearStartDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lastYearEndDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ratio" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/net-margin": { "get": { "tags": [ "ratios-controller" ], "summary": "Get net margin ratio", "operationId": "getNetMargin", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/liquidity-ratio": { "get": { "tags": [ "ratios-controller" ], "summary": "Get liquidity ratio", "operationId": "getLiquidityRatio", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/gross-margin": { "get": { "tags": [ "ratios-controller" ], "summary": "Get gross margin ratio", "operationId": "getGrossMargin", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/average-weighted-receivables": { "get": { "tags": [ "ratios-controller" ], "summary": "Get average weighted receivables ratio", "operationId": "getAverageWeightedReceivables", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/average-weighted-payables": { "get": { "tags": [ "ratios-controller" ], "summary": "Get average weighted payable ratio", "operationId": "getAverageWeightedPayables", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/average-receivables": { "get": { "tags": [ "ratios-controller" ], "summary": "Get average receivables ratio", "operationId": "getAverageReceivables", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/average-payables": { "get": { "tags": [ "ratios-controller" ], "summary": "Get average payable ratio", "operationId": "getAveragePayables", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ratios/annual-employee-count": { "get": { "tags": [ "ratios-controller" ], "summary": "Get annual employee count", "operationId": "getAnnualEmployeeCount", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "departmentId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get list of purchase invoices", "operationId": "getInvoices", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoiceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{id}": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get details of purchase invoice", "operationId": "find_5", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "purchase-invoice-controller" ], "summary": "Delete purchase invoice", "operationId": "delete_7", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{id}/deleted": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get details of deleted purchase invoice", "operationId": "findOne_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedPurchaseInvoice" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/total": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get total values for list of purchase invoices", "operationId": "calculateTotal_6", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoiceBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/supplier": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get list of purchase invoices suppliers", "operationId": "getPurchaseInvoicesSuppliers", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/overall": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get total results count for list of purchase invoice using advanced filters", "operationId": "calculateAdvancedResultCount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/modified-purchase-invoice": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get modified purchase invoice list", "operationId": "modifiedPurchaseInvoice", "parameters": [ { "name": "cutoffDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timezoneName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoiceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/download-archive": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Download purchase invoice documents as an archive", "operationId": "downloadFiles", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/advanced": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get list of purchase invoices using advanced filters", "operationId": "getAdvancedFilters_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseAdvancedFilterPurchaseInvoiceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/advanced/total": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get total values for list of purchase invoices using advanced filters", "operationId": "calculateAdvancedTotal_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseAdvancedFilterPurchaseInvoiceView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/accounting/{id}": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get accounting entries for purchase invoice", "operationId": "getAccounting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAccounting" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/accounting/{id}/deleted": { "get": { "tags": [ "purchase-invoice-controller" ], "summary": "Get deleted accounting entries for purchase invoice", "operationId": "getDeletedAccounting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAccounting" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan": { "get": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Get list of purchase invoice scans", "operationId": "getPurchaseInvoiceScans", "parameters": [ { "name": "pageNumber", "in": "query", "description": "pageNumber", "schema": { "type": "integer", "default": 1 } }, { "name": "sizePerPage", "in": "query", "description": "sizePerPage", "schema": { "type": "integer", "default": 60 } }, { "name": "sortingField", "in": "query", "description": "sortingField", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC,DESC" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoiceScanView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/{id}": { "get": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Get details of purchase invoice scan", "operationId": "find_6", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoiceScan" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Delete purchase invoice scan", "operationId": "delete_8", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/{id}/recognized-data": { "get": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Get purchase invoice scan recognized data", "operationId": "getRecognizedDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecognizedDocument" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/total": { "get": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Get total values for list of purchase invoice scans", "operationId": "calculateTotal_7", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoiceScanView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice-scan/overall": { "get": { "tags": [ "purchase-invoice-scan-controller" ], "summary": "Get total results count for list of purchase invoice scans", "operationId": "calculateResultCount_13", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pl/report": { "get": { "tags": [ "pl-report-controller" ], "summary": "Get profit and loss", "operationId": "getPLReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyElementObject" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pl/report/export": { "get": { "tags": [ "pl-report-controller" ], "summary": "Export profit and loss", "operationId": "getPLReportExport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pl/report/annual": { "get": { "tags": [ "pl-report-controller" ], "summary": "Get profit and loss for the last 12 months", "operationId": "getAnnualPLReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PLReportLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pdf-template": { "get": { "tags": [ "pdf-template-controller" ], "summary": "Get list of organization`s PDF templates", "operationId": "getPdfTemplates", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PdfTemplateView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pdf-template/{id}": { "get": { "tags": [ "pdf-template-controller" ], "summary": "Get details of PDF template", "operationId": "getPdfTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PdfTemplate" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "pdf-template-controller" ], "summary": "Delete PDF template", "operationId": "deletePdfTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/pdf-template/global": { "get": { "tags": [ "pdf-template-controller" ], "summary": "Get list of admins` PDF templates", "operationId": "getGlobalPdfTemplates", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PdfTemplateView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip": { "get": { "tags": [ "payslip-controller" ], "summary": "Get list of salary configs", "operationId": "getTableView_13", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/{id}": { "get": { "tags": [ "payslip-controller" ], "summary": "Get details of salary config", "operationId": "findPayslipById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payslip" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "payslip-controller" ], "summary": "Delete salary config", "operationId": "delete_9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/{id}/lines": { "get": { "tags": [ "payslip-controller" ], "summary": "Get list of salary config lines", "operationId": "getPayslipLines", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLineView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/source-tax-lines/{calendarYear}": { "get": { "tags": [ "payslip-controller" ], "summary": "Get source tax lines of calendar year", "operationId": "findSourceTaxLines", "parameters": [ { "name": "calendarYear", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceTaxLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/region": { "get": { "tags": [ "payslip-controller" ], "summary": "Get details of region salary config", "operationId": "findRegionPayslips", "parameters": [ { "name": "countryCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "regionCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Payslip" } } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/line/{id}": { "get": { "tags": [ "payslip-controller" ], "summary": "Get salary config line details", "operationId": "getPayslipLineDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayslipLine" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/cla": { "get": { "tags": [ "payslip-controller" ], "summary": "Get details of cla salary configs", "operationId": "findClaPayslips", "parameters": [ { "name": "calendarYear", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "countryId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payslip" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payslip/cla-lines": { "get": { "tags": [ "payslip-controller" ], "summary": "Get details of cla salary configs", "operationId": "findClaTableLines", "parameters": [ { "name": "countryId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayslipLineNumberContainer" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll": { "get": { "tags": [ "payroll-controller" ], "summary": "Get list of payrolls", "operationId": "getTableView_14", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/{id}": { "get": { "tags": [ "payroll-controller" ], "summary": "Get details of payroll", "operationId": "findPayslipById_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "payroll-controller" ], "summary": "Delete payroll", "operationId": "delete_10", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/total": { "get": { "tags": [ "payroll-controller" ], "summary": "Get total values for list of payrolls", "operationId": "calculateTotal_8", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/payroll-table/line-names/{calendarYear}/{organizationId}": { "get": { "tags": [ "payroll-controller" ], "summary": "Get list of salary lines for payroll", "operationId": "getSalaryLinesForPayroll", "parameters": [ { "name": "calendarYear", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/overall": { "get": { "tags": [ "payroll-controller" ], "summary": "Get total results count for list of payrolls", "operationId": "calculateResultCount_14", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/insurance/export": { "get": { "tags": [ "payroll-report-controller" ], "summary": "Export insurance declaration", "operationId": "getInsuranceReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/gross-salary/export": { "get": { "tags": [ "payroll-report-controller" ], "summary": "Export gross salary", "operationId": "getPayrollReportExport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/end-of-year/export": { "get": { "tags": [ "payroll-report-controller" ], "summary": "Export end of year report", "operationId": "getEndOfYearReport", "parameters": [ { "name": "contactId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/employees": { "get": { "tags": [ "payroll-controller" ], "summary": "Get list of employees for payroll generation", "operationId": "getAvailableEmployees", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeePayrollView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/employee": { "get": { "tags": [ "payroll-controller" ], "summary": "Get list of payroll employees", "operationId": "getPayrollEmployees", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/employee-taxes/export": { "get": { "tags": [ "payroll-report-controller" ], "summary": "Export employee taxes", "operationId": "getEmployeeTaxesReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/calendar-years/{organizationId}": { "get": { "tags": [ "payroll-controller" ], "summary": "Get list of salary config calendar years for organization", "operationId": "getAvailableCalendarYears", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/avs/export": { "get": { "tags": [ "payroll-report-controller" ], "summary": "Export AVS report", "operationId": "getAvsDeclarationReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/advanced": { "get": { "tags": [ "payroll-advanced-controller" ], "summary": "Get list of payrolls using advanced filters", "operationId": "getTableViewAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/advanced/total": { "get": { "tags": [ "payroll-advanced-controller" ], "summary": "Get total values for list of payrolls using advanced filters", "operationId": "calculateTotal_9", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/advanced/overall": { "get": { "tags": [ "payroll-advanced-controller" ], "summary": "Get total results count for list of payrolls using advanced filters", "operationId": "calculateResultCount_15", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payroll/accounting/{id}": { "get": { "tags": [ "payroll-controller" ], "summary": "Get accounting entries for payroll", "operationId": "getAccounting_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceAccounting" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable": { "get": { "tags": [ "payable-controller" ], "summary": "Get list of payables", "operationId": "getTableView_15", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayableView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/total": { "get": { "tags": [ "payable-controller" ], "summary": "Get total values for list of payables", "operationId": "calculateTotal_10", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/overall": { "get": { "tags": [ "payable-controller" ], "summary": "Get total results count for list of payables", "operationId": "calculateResultCount_16", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/future": { "get": { "tags": [ "payable-controller" ], "summary": "Get list of future payables", "operationId": "getFuturePayables", "parameters": [ { "name": "days", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceContactInfo" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/filters": { "get": { "tags": [ "payable-controller" ], "summary": "Prepare filters for get list of payables", "operationId": "prepareFilters_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/contact": { "get": { "tags": [ "payable-controller" ], "summary": "Get list of contacts used in payables", "operationId": "getContacts_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/advanced": { "get": { "tags": [ "payable-advanced-controller" ], "summary": "Get list of payables using advanced filters", "operationId": "getTableView_16", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayableView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/advanced/total": { "get": { "tags": [ "payable-advanced-controller" ], "summary": "Get total values for list of payables using advanced filters", "operationId": "calculateTotal_11", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/payable/advanced/overall": { "get": { "tags": [ "payable-advanced-controller" ], "summary": "Get total results count for list of payables using advanced filters", "operationId": "calculateResultCount_17", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/{id}": { "get": { "tags": [ "organization-controller" ], "summary": "Get details of organization", "operationId": "find_7", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "activeOnly", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "organization-controller" ], "summary": "Delete organization", "operationId": "delete_11", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/tree/{id}": { "get": { "tags": [ "organization-controller" ], "summary": "Get organizations tree for a contact", "operationId": "getTreeByContactId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactOrganizationAccess" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/templates/{organizationId}": { "get": { "tags": [ "organization-controller" ], "summary": "Get a list of organization templates", "operationId": "getOrganizationTemplates", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationTemplateShortInfo" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/salary-table/line-names/{countryId}": { "get": { "tags": [ "organization-controller" ], "summary": "Get list of possible salary table lines", "description": "Returns list of possible salary table lines grouped by calendar year", "operationId": "getSalaryTableLineNames", "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLineNameNumber" } } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/salary-codes/{organizationId}": { "get": { "tags": [ "organization-controller" ], "summary": "Get salary codes for organizations", "description": "Returns salary codes, cla and region salary codes grouped by calendar year", "operationId": "getAccountingInformation", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalaryCodesContainer" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/payslip-years/{countryId}": { "get": { "tags": [ "organization-controller" ], "summary": "Get list of salary config years", "operationId": "getPayslipYearsByCountryId", "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/other-languages/{id}": { "get": { "tags": [ "organization-controller" ], "summary": "Get other languages for a contact", "operationId": "getOtherLanguagesByContactId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/offices/{organizationId}": { "get": { "tags": [ "organization-controller" ], "summary": "Get a list of offices of a specific organization", "operationId": "getOfficesForOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationAddress" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/languages": { "get": { "tags": [ "organization-controller" ], "summary": "Get list of languages for organization", "operationId": "getLanguagesForCurrentOrganization", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/hpb/{ebicsId}": { "get": { "tags": [ "organization-controller" ], "summary": "Initiate ebics key for organization ebics record", "operationId": "ini", "parameters": [ { "name": "ebicsId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "user", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/WealUserDetails" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ebics" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/generate-ebics-key/{ebicsId}": { "get": { "tags": [ "organization-controller" ], "summary": "Generate ebics key for organization ebics record", "operationId": "generate_1", "parameters": [ { "name": "ebicsId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "user", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/WealUserDetails" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ebics" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/employee-group": { "get": { "tags": [ "organization-controller" ], "summary": "Get list of employee groups for organization", "operationId": "getEmployeeGroupsForCurrentOrganization", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationEmployeeGroup" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/ebics-servers/{organizationId}": { "get": { "tags": [ "organization-controller" ], "summary": "Get available ebics servers for organization", "operationId": "getEbicsServers", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EbicsServer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/currency-exchange": { "get": { "tags": [ "organization-currency-exchange-controller" ], "summary": "Get list of currency exchange rates for organization", "operationId": "getTableView_17", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationCurrencyExchangeView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/currency-exchange/{id}": { "get": { "tags": [ "organization-currency-exchange-controller" ], "summary": "Get details of currency exchange rate for organization", "operationId": "find_8", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCurrencyExchange" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "organization-currency-exchange-controller" ], "summary": "Delete currency exchange rate for organization", "operationId": "delete_12", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/contribution-table/lines/{countryId}": { "get": { "tags": [ "organization-controller" ], "summary": "Get list of possible contribution table lines", "description": "Returns list of possible contribution table lines grouped by calendar year", "operationId": "getContributionTableLines", "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLineNameNumber" } } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/codes": { "get": { "tags": [ "organization-controller" ], "summary": "Get details of organization default codes", "operationId": "getDefaultCodes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultCodesDetails" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/can-create": { "get": { "tags": [ "organization-controller" ], "summary": "Check whether can create organization according to existing billing plan", "operationId": "getCanCreate", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/bank-account-id": { "get": { "tags": [ "organization-controller" ], "summary": "Get ID of chart of account linked to the main bank of organization of the current user", "operationId": "findBankAccountId", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/organization/advanced": { "get": { "tags": [ "organization-advanced-controller" ], "summary": "Get list of organizations using advanced filters", "operationId": "getOrganizationsAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders": { "get": { "tags": [ "order-controller" ], "summary": "Get list of orders", "operationId": "getOrders", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}": { "get": { "tags": [ "order-controller" ], "summary": "Get details of order", "operationId": "getOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "order-controller" ], "summary": "Delete order", "operationId": "delete_13", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/partially-paid-order": { "get": { "tags": [ "order-controller" ], "summary": "Get order considering partially paid amounts", "operationId": "getPartiallyPaidOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/partially-paid-order-elements": { "get": { "tags": [ "order-controller" ], "summary": "Get partially paid order elements", "operationId": "getPartiallyPaidOrderElements", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartiallyPaidOrderBrief" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/full": { "get": { "tags": [ "order-controller" ], "summary": "Get details of order and its list representation", "operationId": "getOrderAndViewDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAndView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/deleted": { "get": { "tags": [ "order-controller" ], "summary": "Get details of deleted order", "operationId": "getDeletedOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedOrder" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/total": { "get": { "tags": [ "order-controller" ], "summary": "Get total values for list of orders", "operationId": "calculateTotal_12", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAdvancedView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/possible-parents/{id}/{contactId}": { "get": { "tags": [ "order-controller" ], "summary": "Get list of possible order parents", "operationId": "getPossibleParents", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/overall": { "get": { "tags": [ "order-controller" ], "summary": "Get total results count for list of orders", "operationId": "calculateResultCount_18", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/invoices": { "get": { "tags": [ "order-controller" ], "summary": "Get list of order invoices", "operationId": "getOrderInvoices", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderInvoiceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/invoices/total": { "get": { "tags": [ "order-controller" ], "summary": "Get total for list of order invoices", "operationId": "getOrderInvoicesTotal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInvoiceView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/invoices/overall": { "get": { "tags": [ "order-controller" ], "summary": "Get count of order invoices", "operationId": "getOrderInvoicesCount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/expenses": { "get": { "tags": [ "order-controller" ], "summary": "Get list of order expenses", "operationId": "getOrderExpenses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderExpenseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/expenses/total": { "get": { "tags": [ "order-controller" ], "summary": "Get total for list of order expenses", "operationId": "getOrderExpensesTotal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderExpenseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/expenses/overall": { "get": { "tags": [ "order-controller" ], "summary": "Get count of order expenses", "operationId": "getOrderExpensesCount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/advanced": { "get": { "tags": [ "order-advanced-controller" ], "summary": "Get list of orders using advanced filtering", "operationId": "getOrdersAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAdvancedBaseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/order-reports": { "get": { "tags": [ "order-reports-controller" ], "summary": "Get list of order reports", "operationId": "getOrderReports", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReportsView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/order-reports/{id}/lines": { "get": { "tags": [ "order-reports-controller" ], "summary": "Get order reports details lines", "operationId": "getReportsDetailsLines", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReportsDetailsLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/order-reports/total": { "get": { "tags": [ "order-reports-controller" ], "summary": "Get total values for list of order reports", "operationId": "calculateTotal_13", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReportsView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/order-reports/overall": { "get": { "tags": [ "order-reports-controller" ], "summary": "Get total results count for list of order reports", "operationId": "calculateResultCount_19", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/user-group-ids": { "get": { "tags": [ "my-account-controller" ], "summary": "Get list of user group ids", "operationId": "getUserGroupIds", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/permission": { "get": { "tags": [ "my-account-controller" ], "summary": "Get list of account permissions", "operationId": "getPermissions", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/licence": { "get": { "tags": [ "my-account-controller" ], "summary": "Get my account licence type in selected organization", "operationId": "getMyAccountLicenceType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "enum": [ "FREE", "PREMIUM" ] } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/invoice-scans-email": { "get": { "tags": [ "my-account-controller" ], "summary": "Get invoice scan email for organization of the current user", "operationId": "getInvoiceScansEmailAddress", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/expenses-report": { "get": { "tags": [ "my-account-controller" ], "summary": "Get expenses report for the current user", "operationId": "getTableView_18", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierExpenseReportView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/expenses-report/total": { "get": { "tags": [ "my-account-controller" ], "summary": "Get total values for list of expenses report for the current user", "operationId": "calculateTotal_14", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoiceBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/expenses-report/overall": { "get": { "tags": [ "my-account-controller" ], "summary": "Get total results count for expenses report for the current user", "operationId": "calculateResultCount_20", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/current-organization-details": { "get": { "tags": [ "my-account-controller" ], "summary": "Get details of current organization", "operationId": "getCurrentOrganizationDetails", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentOrganizationDetails" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/myaccount/allowed-modules": { "get": { "tags": [ "my-account-controller" ], "summary": "Get list of modules user has access to because of workflow", "operationId": "getAllowedModules", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-workflow-notification": { "get": { "tags": [ "my-workflow-notification-controller" ], "summary": "Get list of my workflow notifications", "operationId": "getTableView_19", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotificationView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-workflow-notification/send-email": { "get": { "tags": [ "my-workflow-notification-controller" ], "summary": "Send workflow notifications by email", "operationId": "sendEmail", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-workflow-notification/overall": { "get": { "tags": [ "my-workflow-notification-controller" ], "summary": "Get total results count for list of my workflow notifications", "operationId": "getResultsCount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/{date}": { "get": { "tags": [ "my-timesheet-controller" ], "summary": "Get timesheets for a week by date", "operationId": "getWeekTimesheet", "parameters": [ { "name": "date", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeekTimesheet" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/task": { "get": { "tags": [ "my-timesheet-controller" ], "summary": "Get list of tasks", "description": "Returns a map {id, name}", "operationId": "getOrganizationTasks_1", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "default": "user" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/order": { "get": { "tags": [ "my-timesheet-controller" ], "summary": "Get list of available timsheet orders", "operationId": "getTimesheetOrders_1", "parameters": [ { "name": "clientId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "default": "user" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderForTimesheet" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/employee/task": { "get": { "tags": [ "my-timesheet-controller" ], "summary": "Get list of employee tasks", "description": "Returns a map {id, name}", "operationId": "getCurrentEmployeeTasks", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/client": { "get": { "tags": [ "my-timesheet-controller" ], "summary": "Get list of available timsheet clients", "description": "Returns a map {contactId, contactName}", "operationId": "getTimesheetClients", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "default": "user" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/all-orders": { "get": { "tags": [ "my-timesheet-controller" ], "summary": "Get list of all timesheet orders", "operationId": "getAllTimesheetOrders", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderBrief" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-payroll": { "get": { "tags": [ "my-payroll-controller" ], "summary": "Get list of payrolls for the current user", "operationId": "getTableView_20", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-payroll/overall": { "get": { "tags": [ "my-payroll-controller" ], "summary": "Get total results count for list of payrolls for the current user", "operationId": "calculateResultCount_21", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get list of expenses for user with flag supplier set to true", "operationId": "getTableView_21", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseBaseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/{id}": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get details of expense", "operationId": "getExpense", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "my-expenses-controller" ], "summary": "Delete expense", "operationId": "delete_14", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/total": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get total values for list of expenses for user with flag supplier set to true", "operationId": "getTotal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/overall": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get total results count for list of expenses for user with flag supplier set to true", "operationId": "calculateResultCount_22", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/orders": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get list of available orders", "operationId": "getOrders_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderForMyExpense" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/offices": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get a list of offices", "description": "Returns a map {addressId, addressName}", "operationId": "getOffices", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/merchants": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get list of merchants", "operationId": "getMerchants", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Merchant" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/expense-category": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get expense categories", "operationId": "findExpenseCategory", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserLanguageChartOfAccountsView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/department-tree": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get list of departments", "operationId": "getDepartmentTree", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/clients": { "get": { "tags": [ "my-expenses-controller" ], "summary": "Get list of available clients", "description": "Returns a map {contactId, contactName}", "operationId": "getClients", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/advanced": { "get": { "tags": [ "my-expenses-advanced-controller" ], "summary": "Get list of expenses for user with flag supplier set to true using advanced filters", "operationId": "getExpenseAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyExpenseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/advanced/total": { "get": { "tags": [ "my-expenses-advanced-controller" ], "summary": "Get total values for list of expenses for user with flag supplier set to true using advanced filters", "operationId": "getTotal_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-expenses/advanced/overall": { "get": { "tags": [ "my-expenses-advanced-controller" ], "summary": "Get total results count for list of expenses for user with flag supplier set to true using advanced filters", "operationId": "calculateResultCount_23", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/logo": { "get": { "tags": [ "entry-controller" ], "summary": "Get organisation left hand menu logo", "operationId": "getMenuLogo", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/workflow-notification-action-types": { "get": { "tags": [ "list-controller" ], "summary": "Get workflow notification action types", "description": "Returns a map {type: translation}", "operationId": "getWorkflowNotificationActionTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/workflow-action-types": { "get": { "tags": [ "list-controller" ], "summary": "Get workflow action types by module", "operationId": "getWorkflowActionTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/TranslatedWorkflowActionTypeDetails" } } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/work-permits": { "get": { "tags": [ "list-controller" ], "summary": "Get work permits", "operationId": "getWorkPermits", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkPermit" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/vat/type": { "get": { "tags": [ "list-controller" ], "summary": "Get VAT types", "description": "Returns a map {type: translation}", "operationId": "getVatRule", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/vat/rate": { "get": { "tags": [ "list-controller" ], "summary": "Get VAT rates for date", "operationId": "getVatRate_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatRate" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/vat/code": { "get": { "tags": [ "list-controller" ], "summary": "Get VAT codes for date", "operationId": "getVatCode_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatCode" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/validated-by-default-types": { "get": { "tags": [ "list-controller" ], "summary": "Get validated by default types", "description": "Returns a map {type: translation}", "operationId": "getValidatedByDefaultTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/user-group-types": { "get": { "tags": [ "list-controller" ], "summary": "Get user group types", "description": "Returns a map {type: translation}", "operationId": "getUserGroupTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/training-level": { "get": { "tags": [ "list-controller" ], "summary": "Get staff training levels", "description": "Returns a map {type: translation}", "operationId": "getTrainingLevels", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/timesheet/status": { "get": { "tags": [ "list-controller" ], "summary": "Get timesheet statuses", "description": "Returns a map {status: translation}", "operationId": "getTimesheetType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/sub-order-status-types": { "get": { "tags": [ "list-controller" ], "summary": "Get sub-order status types", "description": "Returns a map {type: translation}", "operationId": "getSubOrderStatusType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/stock/type": { "get": { "tags": [ "list-controller" ], "summary": "Get stock movement types", "description": "Returns a map {type: translation}", "operationId": "getStockMovementType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/stock/movement-direction": { "get": { "tags": [ "list-controller" ], "summary": "Get stock movement directions", "description": "Returns a map {type: translation}", "operationId": "getStockMovementDirectionType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/stock-strategy-type": { "get": { "tags": [ "list-controller" ], "summary": "Get stock strategy types", "description": "Returns a map {type: translation}", "operationId": "getStockStrategyType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/single-parent": { "get": { "tags": [ "list-controller" ], "summary": "Get staff single parent types", "description": "Returns a map {type: translation}", "operationId": "getSingleParentType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/secure-connection-type": { "get": { "tags": [ "list-controller" ], "summary": "Get secure connection types", "description": "Returns a map {type: translation}", "operationId": "getSecureConnectionTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/sales-invoice-statuses": { "get": { "tags": [ "list-controller" ], "summary": "Get sales invoice statuses", "description": "Returns a map {status: translation}", "operationId": "getSalesInvoiceStatuses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/salary-type": { "get": { "tags": [ "list-controller" ], "summary": "Get salary types", "description": "Returns a map {type: translation}", "operationId": "getSalaryTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/report/ratio-line-types": { "get": { "tags": [ "list-controller" ], "summary": "Get ratios report template line types", "description": "Returns a map {type: translation}", "operationId": "getRatioLineTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Translation" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/report/line-types": { "get": { "tags": [ "list-controller" ], "summary": "Get report template line types", "description": "Returns a map {type: translation}", "operationId": "getReportLineTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/report/line-signs": { "get": { "tags": [ "list-controller" ], "summary": "Get report template line signs", "description": "Returns a map {sign: translation}", "operationId": "getReportLineSigns", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "CASH_FLOW", "RATIOS" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/report/cash-flow-line-types": { "get": { "tags": [ "list-controller" ], "summary": "Get cash flow report template line types", "description": "Returns a map {type: translation}", "operationId": "getCashFlowLineTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Translation" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/registry-mutations": { "get": { "tags": [ "list-controller" ], "summary": "Get registry mutation list", "operationId": "getRegistryMutations", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryMutation" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/regions": { "get": { "tags": [ "list-controller" ], "summary": "Get regions by country", "operationId": "getRegions", "parameters": [ { "name": "countryCode2", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/reconciliation/payment-types": { "get": { "tags": [ "list-controller" ], "summary": "Get reconciliation payment types", "operationId": "getReconciliationPaymentTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/reconciliation/document-types": { "get": { "tags": [ "list-controller" ], "summary": "Get reconciliation document types", "description": "Returns a map {type: translation}", "operationId": "getReconciliationDocumentTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/reconciliation/directions": { "get": { "tags": [ "list-controller" ], "summary": "Get reconciliation directions", "description": "Returns a map {direction: translation}", "operationId": "getReconciliationDirections", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/receivable-payment-types": { "get": { "tags": [ "list-controller" ], "summary": "Get receivable payment types", "description": "Returns a map {type: translation}", "operationId": "getReceivablesPaymentTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/purpose-codes": { "get": { "tags": [ "list-controller" ], "summary": "Get payment purpose codes by country", "operationId": "getPaymentPurposeCodes", "parameters": [ { "name": "countryCode2", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPurposeCode" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/purchase-invoice-statuses": { "get": { "tags": [ "list-controller" ], "summary": "Get purchase invoice statuses", "description": "Returns a map {status: translation}", "operationId": "getPurchaseInvoiceStatuses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/purchase-invoice-journal-entry-type": { "get": { "tags": [ "list-controller" ], "summary": "Get purchase invoice journal entry types", "description": "Returns a map {type: translation}", "operationId": "getPurchaseInvoiceJournalEntryTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/position": { "get": { "tags": [ "list-controller" ], "summary": "Get staff positions", "description": "Returns a map {type: translation}", "operationId": "getPositions", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/permission-can-types": { "get": { "tags": [ "list-controller" ], "summary": "Get permission can types", "description": "Returns a map {time: translation}", "operationId": "getPermissionCanTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/pdf-template-types": { "get": { "tags": [ "list-controller" ], "summary": "Get PDF template types", "description": "Returns a map {type: translation}", "operationId": "getPdfTemplateTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payslip-value-types": { "get": { "tags": [ "list-controller" ], "summary": "Get salary config value types", "description": "Returns a map {type: translation}", "operationId": "getPayslipValueTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payslip-value-split-types": { "get": { "tags": [ "list-controller" ], "summary": "Get salary config value split types", "description": "Returns a map {type: translation}", "operationId": "getPayslipValueSplitTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payslip-status": { "get": { "tags": [ "list-controller" ], "summary": "Get payslip statuses", "description": "Returns a map {status: translation}", "operationId": "getPayslipStatuses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payslip-special-attribution-types": { "get": { "tags": [ "list-controller" ], "summary": "Get salary config special attribution types", "description": "Returns a map {type: translation}", "operationId": "getPayslipSpecialAttributionTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payslip-line-types": { "get": { "tags": [ "list-controller" ], "summary": "Get payment line types", "description": "Returns a map {type: translation}", "operationId": "getPayslipLineTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payslip-line-sign-types": { "get": { "tags": [ "list-controller" ], "summary": "Get salary config line signs", "description": "Returns a map {sign: translation}", "operationId": "getPayslipLineSignTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payslip-limit-calculation-types": { "get": { "tags": [ "list-controller" ], "summary": "Get salary config calculation types", "description": "Returns a map {type: translation}", "operationId": "getLimitCalculationTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payroll-statuses": { "get": { "tags": [ "list-controller" ], "summary": "Get payroll statuses", "description": "Returns a map {status: translation}", "operationId": "getPayrollStatuses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/payable-payment-types": { "get": { "tags": [ "list-controller" ], "summary": "Get payable payment types", "description": "Returns a map {type: translation}", "operationId": "getPayablePaymentTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/order-status-types": { "get": { "tags": [ "list-controller" ], "summary": "Get order statuses", "description": "Returns a map {status: translation}", "operationId": "getOrderStatusType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/order-periodicity-type": { "get": { "tags": [ "list-controller" ], "summary": "Get order periodicity values", "description": "Returns a map {value: translation}", "operationId": "getOrderPeriodicityType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/order-invoicing-time": { "get": { "tags": [ "list-controller" ], "summary": "Get order invoicing times", "description": "Returns a map {time: translation}", "operationId": "getOrderInvoicingTime", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/order-invoice-types": { "get": { "tags": [ "list-controller" ], "summary": "Get order invoice types", "description": "Returns a map {type: translation}", "operationId": "getOrderInvoiceTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/order-article-status": { "get": { "tags": [ "list-controller" ], "summary": "Get order article statuses", "description": "Returns a map {status: translation}", "operationId": "getOrderArticleStatuses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/noga-codes": { "get": { "tags": [ "list-controller" ], "summary": "Get NOGA codes", "operationId": "getNogaCodes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NogaCode" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/month-type": { "get": { "tags": [ "list-controller" ], "summary": "Get month types", "description": "Returns a map {type: translation}", "operationId": "getMonthTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/measurements": { "get": { "tags": [ "list-controller" ], "summary": "Get article measurements", "description": "Returns a map {measurement: translation}", "operationId": "getMeasurements", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/marital-type": { "get": { "tags": [ "list-controller" ], "summary": "Get martial types", "description": "Returns a map {type: translation}", "operationId": "getMaritalTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/localities/{postalCode}": { "get": { "tags": [ "list-controller" ], "summary": "Get localities list by postal code", "operationId": "getLocalities", "parameters": [ { "name": "postalCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Canton" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/languages": { "get": { "tags": [ "list-controller" ], "summary": "Get languages", "operationId": "getLanguageList", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageEntity" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/invoice-scan/status": { "get": { "tags": [ "list-controller" ], "summary": "Get invoice scan statuses", "description": "Returns a map {status: translation}", "operationId": "getInvoiceScanStatus", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/invoice-scan/payment-type": { "get": { "tags": [ "list-controller" ], "summary": "Get invoice scan payment types", "description": "Returns a map {type: translation}", "operationId": "getInvoiceScanPaymentType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/immobilization-types": { "get": { "tags": [ "list-controller" ], "summary": "Get immobilization types", "description": "Returns a map {type: translation}", "operationId": "getImmobilizationTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/group-type": { "get": { "tags": [ "list-controller" ], "summary": "Get group types", "description": "Returns a map {type: translation}", "operationId": "getGroupTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/gender-type": { "get": { "tags": [ "list-controller" ], "summary": "Get gender types", "description": "Returns a map {type: translation}", "operationId": "getGenderTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/family-member-type": { "get": { "tags": [ "list-controller" ], "summary": "Get family member types", "description": "Returns a map {type: translation}", "operationId": "getFamilyMemberTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/expense-statuses": { "get": { "tags": [ "list-controller" ], "summary": "Get expense statuses", "description": "Returns a map {status: translation}", "operationId": "getExpenseStatuses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/expense-payment-types": { "get": { "tags": [ "list-controller" ], "summary": "Get expense payment types", "description": "Returns a map {type: translation}", "operationId": "getExpensePaymentTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/employee-document-type": { "get": { "tags": [ "list-controller" ], "summary": "Get employee document types", "description": "Returns a map {type: translation}", "operationId": "getEmployeeDocumentTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/ebics-statuses": { "get": { "tags": [ "list-controller" ], "summary": "Get ebics key generation statuses", "description": "Returns a map {status: translation}", "operationId": "getEbicsKeyGenerationStatus", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/document-extension": { "get": { "tags": [ "list-controller" ], "summary": "Get document extensions", "description": "Returns a list of extensions", "operationId": "getDocumentExtensions", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/denomination": { "get": { "tags": [ "list-controller" ], "summary": "Get staff denomination types", "description": "Returns a map {type: translation}", "operationId": "getDenomination", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/days-of-week": { "get": { "tags": [ "list-controller" ], "summary": "Get days of week", "description": "Returns a map {dayOfWeek: translation}", "operationId": "getDaysOfWeek", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/currencies": { "get": { "tags": [ "list-controller" ], "summary": "Get currencies", "operationId": "getCurrencies", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyEntity" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/countries": { "get": { "tags": [ "list-controller" ], "summary": "Get countries", "operationId": "getCountries", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/cost-calculation-type": { "get": { "tags": [ "list-controller" ], "summary": "Get cost calculation types", "description": "Returns a map {type: translation}", "operationId": "getCostCalculationType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/contract-type": { "get": { "tags": [ "list-controller" ], "summary": "Get contact types", "description": "Returns a map {type: translation}", "operationId": "getContractTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/communication-type": { "get": { "tags": [ "list-controller" ], "summary": "Get communication types", "operationId": "getCommunicationTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/budget/type": { "get": { "tags": [ "list-controller" ], "summary": "Get budget types", "description": "Returns a map {type: translation}", "operationId": "getReportType", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/budget/status": { "get": { "tags": [ "list-controller" ], "summary": "Get budget statuses", "description": "Returns a map {status: translation}", "operationId": "getBudgetStatus", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/article-types": { "get": { "tags": [ "list-controller" ], "summary": "Get article types", "description": "Returns a map {type: translation}", "operationId": "getArticleTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/permissions": { "get": { "tags": [ "list-controller" ], "summary": "Get list of permissions", "operationId": "getDefaultPermissionList", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/modules": { "get": { "tags": [ "list-controller" ], "summary": "Get application modules", "description": "Returns a map {module: translation}", "operationId": "getAppModules", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/modules/workflowable": { "get": { "tags": [ "list-controller" ], "summary": "Get application workflowable modules", "description": "Returns a map {module: translation}", "operationId": "getAppWorkflowableModules", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/modules/restorable": { "get": { "tags": [ "list-controller" ], "summary": "Get application restorable modules", "description": "Returns a map {module: translation}", "operationId": "getAppRestorableModules", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/licence-types": { "get": { "tags": [ "list-controller" ], "summary": "Get licence types", "description": "Returns a map {module: translation}", "operationId": "getLicenceTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/journal-types": { "get": { "tags": [ "list-controller" ], "summary": "Get journal entry types", "description": "Returns a map {type: translation}", "operationId": "getJournalTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/feesplit-types": { "get": { "tags": [ "list-controller" ], "summary": "Get fee split types", "description": "Returns a map {type: translation}", "operationId": "getFeeSplitTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/actions": { "get": { "tags": [ "list-controller" ], "summary": "Get activity log actions", "description": "Returns a map {action: translation}", "operationId": "getAppActions", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/action-types": { "get": { "tags": [ "list-controller" ], "summary": "Get activity log action types", "description": "Returns a map {type: translation}", "operationId": "getAppActionTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/app/account-types": { "get": { "tags": [ "list-controller" ], "summary": "Get chart of account types", "description": "Returns a map {type: translation}", "operationId": "getAccountTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/amounts/vat/rate": { "get": { "tags": [ "list-controller" ], "summary": "Get VAT rates for amounts for purchase invoices", "operationId": "getAmountsVatRates", "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatRate" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/accounting-period-statuses": { "get": { "tags": [ "list-controller" ], "summary": "Get accounting period statuses", "description": "Returns a map {status: translation}", "operationId": "getAccountingPeriodStatuses", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/list/absence-type": { "get": { "tags": [ "list-controller" ], "summary": "Get absence types", "description": "Returns a map {type: translation}", "operationId": "getAbsenceTypes", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/licenses": { "get": { "tags": [ "licenses-controller" ], "summary": "Get license text", "operationId": "getLicensesText", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger": { "get": { "tags": [ "general-ledger-controller" ], "summary": "Get general ledger", "operationId": "getTableViews", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralLedgerBaseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger/total": { "get": { "tags": [ "general-ledger-controller" ], "summary": "Get total values for general ledger", "operationId": "getTotal_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralLedgerView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger/overall": { "get": { "tags": [ "general-ledger-controller" ], "summary": "Get total results count for list of articles", "operationId": "calculateResultCount_24", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger/open/module/{id}/{type}": { "get": { "tags": [ "general-ledger-controller" ], "summary": "Get ID of an entity related in general ledger", "operationId": "getIdWhenOpenInModule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "OPENING", "MANUAL", "PURCHASE_INVOICE", "SALES_INVOICE", "SALARY_SLIP", "STOCK", "CLOSING", "SYSTEM", "SYSTEM_FX", "SYSTEM_PFUV", "FIXED_ASSET" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger/open/journal/{id}": { "get": { "tags": [ "general-ledger-controller" ], "summary": "Get ID of related journal entry", "operationId": "getIdWhenOpenInJournal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger/advanced": { "get": { "tags": [ "advanced-general-ledger-controller" ], "summary": "Get general ledger", "operationId": "getTableView_22", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedGeneralLedgerView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger/advanced/total": { "get": { "tags": [ "advanced-general-ledger-controller" ], "summary": "Get total values for general ledger", "operationId": "getTotal_3", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralLedgerView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/ledger/advanced/overall": { "get": { "tags": [ "advanced-general-ledger-controller" ], "summary": "Get total results count for list of articles", "operationId": "calculateResultCount_25", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/late-notice": { "get": { "tags": [ "late-notice-controller" ], "summary": "Get list of late notices", "operationId": "getTableView_23", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LateNoticeLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/late-notice/total": { "get": { "tags": [ "late-notice-controller" ], "summary": "Get total values for late notices", "operationId": "getLateNoticesTotal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LateNoticeLine" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/late-notice/overall": { "get": { "tags": [ "late-notice-controller" ], "summary": "Get total results count for list of late notices", "operationId": "calculateResultCount_26", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/late-notice/client": { "get": { "tags": [ "late-notice-controller" ], "summary": "Get list of client late notices", "operationId": "getClientLateNotices", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LateNoticeView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/late-notice/client/total": { "get": { "tags": [ "late-notice-controller" ], "summary": "Get total values for clients table of late notices", "operationId": "getClientLateNoticesTotal", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LateNoticeView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal": { "get": { "tags": [ "journal-controller" ], "summary": "Get list of journal entries", "operationId": "getTableView_24", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal/{id}": { "get": { "tags": [ "journal-controller" ], "summary": "Get details of journal entry", "operationId": "getEntryById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "journal-controller" ], "summary": "Delete journal entry", "operationId": "delete_15", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal/{id}/deleted": { "get": { "tags": [ "journal-controller" ], "summary": "Get details of deleted journal entry", "operationId": "findOne_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal/overall": { "get": { "tags": [ "journal-controller" ], "summary": "Get total results count for list of journal entries", "operationId": "calculateResultCount_27", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/journal/entry-id/{entryId}": { "get": { "tags": [ "journal-controller" ], "summary": "Get details of journal entry by entry ID", "operationId": "getAccount_1", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/impersonate/{id}": { "get": { "tags": [ "impersonate-controller" ], "summary": "Impersonate a user", "operationId": "swapUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Contact" }, { "$ref": "#/components/schemas/OrganizationContact" }, { "$ref": "#/components/schemas/PersonContact" } ] } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/global/super-role/{id}": { "get": { "tags": [ "global-role-controller" ], "summary": "Get details of super-role", "operationId": "findSuperRoleById_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuperRole" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/global/role": { "get": { "tags": [ "global-role-controller" ], "summary": "Get list of roles", "operationId": "getTableView_25", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalRoleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/global/role/{id}": { "get": { "tags": [ "global-role-controller" ], "summary": "Get details of role", "operationId": "findRoleById_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleWithPermissions" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "global-role-controller" ], "summary": "Delete role or super-role", "operationId": "delete_16", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/global/role/permissions": { "get": { "tags": [ "global-role-controller" ], "summary": "Get permissions of list of roles", "operationId": "findPermissionsByRoleIds_1", "parameters": [ { "name": "roleIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/generate-pdfs": { "get": { "tags": [ "pdf-controller" ], "summary": "Export PDF files in zip", "description": "Except mentioned parameters used other ones which are related to particular type", "operationId": "generatePdfs", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "SALES_INVOICE", "LATE_NOTICE", "SALARY_SLIP", "MY_SALARY_SLIP", "SALES_ORDER", "VAT_REPORT", "DELIVERY_NOTE", "GENERAL_LEDGER" ] } }, { "name": "sortingField", "in": "query", "description": "sortingField", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "direction", "schema": { "type": "string", "enum": [ "ASC,DESC" ] } }, { "name": "departmentId", "in": "query", "description": "departmentId", "schema": { "type": "integer" } }, { "name": "useLetterhead", "in": "query", "description": "useLetterhead", "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/generate-pdf": { "get": { "tags": [ "pdf-controller" ], "summary": "Export PDF report", "description": "Except mentioned parameters used other ones which are related to particular type", "operationId": "generatePdf", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "SALES_INVOICE", "LATE_NOTICE", "SALARY_SLIP", "MY_SALARY_SLIP", "SALES_ORDER", "VAT_REPORT", "DELIVERY_NOTE", "GENERAL_LEDGER" ] } }, { "name": "preview", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "exportData", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "sortingField", "in": "query", "description": "sortingField", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "direction", "schema": { "type": "string", "enum": [ "ASC,DESC" ] } }, { "name": "entityId", "in": "query", "description": "entityId", "schema": { "type": "integer" } }, { "name": "departmentId", "in": "query", "description": "departmentId", "schema": { "type": "integer" } }, { "name": "useLetterhead", "in": "query", "description": "useLetterhead", "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/fixed-assets": { "get": { "tags": [ "fixed-assets-controller" ], "summary": "Get fixed assets report", "operationId": "getTableView_26", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetReportView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/fixed-assets/{id}": { "get": { "tags": [ "fixed-assets-controller" ], "summary": "Get details of fixed asset", "operationId": "find_9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixedAsset" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "fixed-assets-controller" ], "summary": "Delete fixed asset", "operationId": "delete_17", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/fixed-assets/total": { "get": { "tags": [ "fixed-assets-controller" ], "summary": "Get total values for fixed assets", "operationId": "getTotal_4", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixedAssetReportView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/fixed-assets/overall": { "get": { "tags": [ "fixed-assets-controller" ], "summary": "Get total results count for fixed assets", "operationId": "calculateResultCount_28", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses": { "get": { "tags": [ "expenses-controller" ], "summary": "Get list of expenses", "operationId": "getTableView_27", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/{id}": { "get": { "tags": [ "expenses-controller" ], "summary": "Get details of expense", "operationId": "getExpense_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "expenses-controller" ], "summary": "Delete expense", "operationId": "delete_18", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/total": { "get": { "tags": [ "expenses-controller" ], "summary": "Get total values for list of expenses", "operationId": "getTotal_5", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/overall": { "get": { "tags": [ "expenses-controller" ], "summary": "Get total results count for list of expenses", "operationId": "calculateResultCount_29", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/merchants": { "get": { "tags": [ "expenses-controller" ], "summary": "Get list of merchants", "operationId": "getMerchants_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantEntity" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get a list of draft expenses", "operationId": "getTableView_28", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseDraftView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/{id}": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get detailed information on the draft expenses", "operationId": "getExpenseDraft", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseDraft" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "expenses-draft-controller" ], "summary": "Delete draft expenses", "operationId": "delete_19", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/total": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get total values for list of draft expenses", "operationId": "getTotal_6", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseDraftView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/overall": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get total results count for list of draft expenses", "operationId": "calculateResultCount_30", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/orders": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get list of available orders", "operationId": "getOrders_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderForMyExpense" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/offices": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get a list of offices", "description": "Returns a map {addressId, addressName}", "operationId": "getOffices_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/merchants": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get list of merchants", "operationId": "getMerchants_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Merchant" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/expense-category": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get expense categories", "operationId": "findExpenseCategory_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserLanguageChartOfAccountsView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/department-tree": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get list of departments", "operationId": "getDepartmentTree_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/draft/clients": { "get": { "tags": [ "expenses-draft-controller" ], "summary": "Get list of available clients", "description": "Returns a map {contactId, contactName}", "operationId": "getClients_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/advanced": { "get": { "tags": [ "expenses-advanced-controller" ], "summary": "Get list of expenses using advanced filters", "operationId": "getExpenseAdvanced_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/advanced/total": { "get": { "tags": [ "expenses-advanced-controller" ], "summary": "Get total values for list of expenses using advanced filters", "operationId": "getTotal_7", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseBaseView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/expenses/advanced/overall": { "get": { "tags": [ "expenses-advanced-controller" ], "summary": "Get total results count for list of expenses using advanced filters", "operationId": "calculateResultCount_31", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document": { "get": { "tags": [ "document-controller" ], "summary": "Get list of documents", "operationId": "getTableView_29", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/{id}": { "get": { "tags": [ "document-controller" ], "summary": "Get details of document", "operationId": "getDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "document-controller" ], "summary": "Delete document file", "operationId": "removeDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/view/{id}": { "get": { "tags": [ "document-controller" ], "summary": "Get document file", "operationId": "viewFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/tags": { "get": { "tags": [ "document-controller" ], "summary": "Get list of tags", "operationId": "filterTags", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTagEntity" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/overall": { "get": { "tags": [ "document-controller" ], "summary": "Get total results count for list of documents", "operationId": "calculateResultCount_32", "parameters": [ { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "enum": [ "ASC,DESC" ] } }, { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer" } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/modules": { "get": { "tags": [ "document-controller" ], "summary": "Get list of modules supporting documents", "description": "Returns a map {module: translation}", "operationId": "getDocumentModules", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/large-to-export": { "get": { "tags": [ "large-document-export-controller" ], "summary": "Get list of large documents to export", "operationId": "getTableView_30", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "large-document-export-controller" ], "summary": "Delete multiple large documents", "operationId": "deleteAll_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/large-to-export/overall": { "get": { "tags": [ "large-document-export-controller" ], "summary": "Get total results count for list of large documents to export", "operationId": "calculateResultCount_33", "parameters": [ { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "enum": [ "ASC,DESC" ] } }, { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer" } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/large-to-export/download/{id}": { "get": { "tags": [ "large-document-export-controller" ], "summary": "Download document file", "operationId": "downloadFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/duplicate/{id}": { "get": { "tags": [ "document-controller" ], "summary": "Duplicate document file", "operationId": "duplicate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/download/{id}": { "get": { "tags": [ "document-controller" ], "summary": "Download document file", "operationId": "downloadFile_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/download/journal-import": { "get": { "tags": [ "document-controller" ], "summary": "Download journal import example file", "operationId": "downloadJournalImport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/download-archive/{archiveName}": { "get": { "tags": [ "document-controller" ], "summary": "Download multiple documents as an archive", "operationId": "downloadFiles_1", "parameters": [ { "name": "archiveName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/contacts": { "get": { "tags": [ "document-controller" ], "summary": "Get list of contacts by criteria", "operationId": "filterContacts", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document-scan": { "get": { "tags": [ "document-scan-controller" ], "summary": "Get list of document scans", "operationId": "getTableView_31", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentScanView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "document-scan-controller" ], "summary": "Delete multiple document scans", "operationId": "deleteAll_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document-scan/overall": { "get": { "tags": [ "document-scan-controller" ], "summary": "Get total results count for list of document scans", "operationId": "calculateResultCount_34", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/department": { "get": { "tags": [ "department-controller" ], "summary": "Get flat list of departments", "operationId": "getDepartments", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/department/tree/{id}": { "get": { "tags": [ "department-controller" ], "summary": "Get list of departments for particular organizations", "operationId": "getDepartmentTreeForOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/currency-exchange": { "get": { "tags": [ "currency-exchange-controller" ], "summary": "Get list of currency exchange rates", "operationId": "getTableView_32", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyExchangeView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/currency-exchange/{id}": { "get": { "tags": [ "currency-exchange-controller" ], "summary": "Get details of currency exchange rate", "operationId": "find_10", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyExchange" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "currency-exchange-controller" ], "summary": "Delete currency exchange rate", "operationId": "delete_20", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/currency-exchange/import/{currency}": { "get": { "tags": [ "currency-exchange-controller" ], "summary": "Trigger currency exchange rates import", "operationId": "updateCurrencyExchangeRates", "parameters": [ { "name": "currency", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "validKey", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact": { "get": { "tags": [ "contact-controller" ], "summary": "Get list of contacts", "operationId": "getTableView_33", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{type}/{id}": { "get": { "tags": [ "contact-controller" ], "summary": "Get details of contact", "operationId": "find_11", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ORGANIZATION", "PERSON" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Contact" }, { "$ref": "#/components/schemas/OrganizationContact" }, { "$ref": "#/components/schemas/PersonContact" } ] } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{type}/{id}/deleted": { "get": { "tags": [ "contact-controller" ], "summary": "Get details of deleted contact", "operationId": "findDeleted", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ORGANIZATION", "PERSON" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Contact" }, { "$ref": "#/components/schemas/OrganizationContact" }, { "$ref": "#/components/schemas/PersonContact" } ] } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}/vcard": { "get": { "tags": [ "contact-controller" ], "summary": "Export contact as vCard", "operationId": "getVCard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}/supplier": { "get": { "tags": [ "contact-controller" ], "summary": "Get details of supplier", "operationId": "getContactSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactSupplier" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}/single-supplier": { "get": { "tags": [ "contact-controller" ], "summary": "Get details of supplier without organization filter", "operationId": "getContactSupplierWithoutOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactSupplier" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}/related": { "get": { "tags": [ "contact-controller" ], "summary": "Get list of related contacts with type PERSON for company", "operationId": "getRelatedTableView", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}/client": { "get": { "tags": [ "contact-controller" ], "summary": "Get details of client", "operationId": "getContactClient", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactClient" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}/balance-of-contact": { "get": { "tags": [ "contact-controller" ], "summary": "Showing all the transactions for a contact of type client (eg. invoices, payments, etc) with a total.", "operationId": "getBalanceOfContact", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceOfTheContact" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/suppliers/{organizationId}": { "get": { "tags": [ "contact-controller" ], "summary": "Get list of suppliers in particular organization", "operationId": "findSuppliersForOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "organizationAccessibleCheck", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "withUidOnly", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierContactListView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/source-tax-codes/{regionId}": { "get": { "tags": [ "contact-controller" ], "summary": "Get source tax codes for particular region", "description": "Returns source tax codes grouped by calendar year", "operationId": "getYearsToSourceTaxCodesByRegionId", "parameters": [ { "name": "regionId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/payslip-years/{organizationId}": { "get": { "tags": [ "contact-controller" ], "summary": "Get salary configuration years for particular organization", "description": "Returns salary configuration years grouped by calendar year", "operationId": "getYearsToPayslipLinesByOrganizationId", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/StaffPayslipContainer" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/payslip-table/line-names/{organizationId}": { "get": { "tags": [ "contact-controller" ], "summary": "Get salary line names for particular organization", "description": "Returns salary line names grouped by calendar year", "operationId": "getPayslipTableLineNames", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLineNameNumber" } } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/overall": { "get": { "tags": [ "contact-controller" ], "summary": "Get total results count for list of contacts", "operationId": "calculateResultCount_35", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/main-user-default": { "get": { "tags": [ "contact-controller" ], "summary": "Get main user default value for new contact for selected organization", "operationId": "getMainUserDefault", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/filter": { "get": { "tags": [ "contact-controller" ], "summary": "Get list of contacts with non-empty phone number", "operationId": "filterContacts_1", "parameters": [ { "name": "phoneExists", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/export-as-vCard": { "get": { "tags": [ "contact-controller" ], "summary": "Export contact list as vCard in zip", "operationId": "exportAsVCard", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/bank-info": { "get": { "tags": [ "contact-controller" ], "summary": "Get client bank name and bic by client bank iban", "operationId": "getClientBankInfo", "parameters": [ { "name": "iban", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankMasterInfo" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/all-organizations-users": { "get": { "tags": [ "contact-controller" ], "summary": "Get all users for all organizations", "operationId": "getAllUsersForAllOrganizations", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/advanced": { "get": { "tags": [ "contact-controller" ], "summary": "Get list of contacts using advanced filters", "operationId": "getAdvancedFilters_2", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/address": { "get": { "tags": [ "contact-controller" ], "summary": "Address and uid by contact name", "operationId": "getAddressByContactName", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact-balance/report": { "get": { "tags": [ "contact-balance-report-controller" ], "summary": "Get contacts balance report", "operationId": "getContactBalanceReportView", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactBalanceReportView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact-balance/report/total": { "get": { "tags": [ "contact-balance-report-controller" ], "summary": "Get total values for contacts balance", "operationId": "calculateResultCount_36", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact-balance/report/overall": { "get": { "tags": [ "contact-balance-report-controller" ], "summary": "Get total results count for contacts balance", "operationId": "getTotal_8", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactBalanceReportView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact-balance/report/advanced": { "get": { "tags": [ "contact-balance-report-controller" ], "summary": "Get contacts balance report with advanced filter", "operationId": "getAdvancedReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactBalanceReportView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact-balance/report/advanced/total": { "get": { "tags": [ "contact-balance-report-controller" ], "summary": "Get total values for contacts balance with advanced filter", "operationId": "calculateAdvancedResultCount_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact-balance/report/advanced/overall": { "get": { "tags": [ "contact-balance-report-controller" ], "summary": "Get total results count for contacts balance with advanced filter", "operationId": "getTotalForAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactBalanceReportView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/consolidated-organization/available": { "get": { "tags": [ "consolidated-organization-controller" ], "summary": "Get available organization for consolidation", "operationId": "getAvailableOrganizationForConsolidation", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts": { "get": { "tags": [ "chart-of-accounts-controller" ], "summary": "Get chart of accounts", "operationId": "getChartOfAccounts", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChartOfAccountsView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts/{id}": { "get": { "tags": [ "chart-of-accounts-controller" ], "summary": "Get details of chart of account", "operationId": "getChartOfAccounts_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartOfAccounts" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "chart-of-accounts-controller" ], "summary": "Delete chart of account", "operationId": "deleteChart", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts/{id}/account-movement": { "get": { "tags": [ "chart-of-accounts-controller" ], "summary": "Return all movements done on an account", "operationId": "accountMovement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "contactId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountMovement" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts/lines": { "get": { "tags": [ "chart-of-accounts-controller" ], "summary": "Get list of journal lines associated to chart of accounts", "operationId": "findJournalLines", "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalChartOfAccountLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts/coa-param": { "get": { "tags": [ "chart-of-accounts-controller" ], "summary": "Get chart of accounts by specific parameters for particular organization", "operationId": "findCOAByParam_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } }, { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserLanguageChartOfAccountsView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts/advanced": { "get": { "tags": [ "chart-of-accounts-advanced-controller" ], "summary": "Get chart of accounts using advanced filters", "operationId": "getChartOfAccountsAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChartOfAccountsView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/chart-accounts/accounts-linked-to-banks": { "get": { "tags": [ "chart-of-accounts-controller" ], "summary": "Get list of chart of accounts linked to banks", "operationId": "findAccountsLinkedToBanks", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserLanguageChartOfAccountsView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/cash-flow/report": { "get": { "tags": [ "cash-flow-report-controller" ], "summary": "Get cash flow", "operationId": "getCashFlowReport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashFlowReportLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/cash-flow/report/export": { "get": { "tags": [ "cash-flow-report-controller" ], "summary": "Export cash flow", "operationId": "getCashFlowReportExport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/cash-flow/extrapolated": { "get": { "tags": [ "cashflow-controller" ], "summary": "Get extrapolated cash flow", "operationId": "getExtrapolatedCashFlow", "parameters": [ { "name": "weeks", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtrapolatedCashFlow" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/budget": { "get": { "tags": [ "budget-controller" ], "summary": "Get list of budgets", "operationId": "getTableView_34", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/budget/{id}": { "get": { "tags": [ "budget-controller" ], "summary": "Get details of budget", "operationId": "getBudget", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Budget" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "budget-controller" ], "summary": "Delete budget", "operationId": "delete_21", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/budget/report/{id}": { "get": { "tags": [ "budget-controller" ], "summary": "Export details of budget", "operationId": "getReport_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/budget/active-exists": { "get": { "tags": [ "budget-controller" ], "summary": "Check whether active budget exists for indicated date range", "operationId": "existsActiveBudget", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/breakdown/income": { "get": { "tags": [ "breakdown-controller" ], "summary": "Get income breakdown diagram data.", "operationId": "getIncomeBreakdownData", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BreakdownData" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/breakdown/expense": { "get": { "tags": [ "breakdown-controller" ], "summary": "Get expense breakdown diagram data.", "operationId": "getExpenseBreakdownData", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BreakdownData" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing": { "get": { "tags": [ "billing-controller" ], "summary": "Get list billing units", "operationId": "getTableView_35", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingUnitView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/overdue-amount": { "get": { "tags": [ "billing-controller" ], "summary": "Get overdue amount for the user", "operationId": "getOverdueAmount", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/overall": { "get": { "tags": [ "billing-controller" ], "summary": "Get total results count for list of billing units", "operationId": "calculateResultCount_37", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/calculate-price": { "get": { "tags": [ "billing-controller" ], "summary": "Calculate price for billing unit amounts", "operationId": "getPricingPlan", "parameters": [ { "name": "billingUnitAmounts", "in": "query", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/billing/billing-plan-with-price": { "get": { "tags": [ "billing-controller" ], "summary": "Get billing plan with price", "operationId": "getBillingPlanWithPrice", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingPlanWithPrice" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/balance": { "get": { "tags": [ "balance-controller" ], "summary": "Get balance", "operationId": "getTableView_36", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/balance/total": { "get": { "tags": [ "balance-controller" ], "summary": "Get total values for balance", "operationId": "getTotal_9", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceView" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/balance/overall": { "get": { "tags": [ "balance-controller" ], "summary": "Get total results count for balance", "operationId": "calculateResultCount_38", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/balance-sheet": { "get": { "tags": [ "balance-sheet-controller" ], "summary": "Get balance sheet", "operationId": "getBalanceSheet", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceSheetLine" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/balance-sheet/monthly-cash": { "get": { "tags": [ "balance-sheet-controller" ], "summary": "Get monthly cash", "operationId": "getMonthlyCash", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MonthlyCash" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/balance-sheet/last-previous-not-inactive-period-start-date": { "get": { "tags": [ "balance-sheet-controller" ], "summary": "Get start date of latest previous opened accounting period", "operationId": "getLastPreviousNotInactivePeriodStartDate", "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/balance-sheet/export": { "get": { "tags": [ "balance-sheet-controller" ], "summary": "Export balance sheet", "operationId": "getBalanceSheetExport", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/attachment/find/{attachmentId}": { "get": { "tags": [ "attachment-controller" ], "summary": "Get avatar", "operationId": "find_12", "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article": { "get": { "tags": [ "article-controller" ], "summary": "Get list of articles", "operationId": "getArticles", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/{id}": { "get": { "tags": [ "article-controller" ], "summary": "Get details of article", "operationId": "find_13", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Article" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "article-controller" ], "summary": "Delete article", "operationId": "deleteArticle", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/{id}/deleted": { "get": { "tags": [ "article-controller" ], "summary": "Get details of deleted article", "operationId": "findOne_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Article" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/{articleCategoryId}/article-category": { "get": { "tags": [ "article-controller" ], "summary": "Get list of lite article items by article category id", "operationId": "findByArticleCategory", "parameters": [ { "name": "articleCategoryId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LiteArticleItem" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/overall": { "get": { "tags": [ "article-controller" ], "summary": "Get total results count for list of articles", "operationId": "calculateResultCount_39", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/lang": { "get": { "tags": [ "article-controller" ], "summary": "Get list of articles with user language", "operationId": "getUserLanguageArticles", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserLanguageArticleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/contact-lang": { "get": { "tags": [ "article-controller" ], "summary": "Get list of articles with contact's default language", "operationId": "getContactLanguageArticles", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TranslatedArticleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/contact-lang/overall": { "get": { "tags": [ "article-controller" ], "summary": "Get overall of list of articles with contact's default language", "operationId": "getContactLanguageArticlesOverall", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/category": { "get": { "tags": [ "article-category-controller" ], "summary": "Get flat list of article categories", "operationId": "getArticleCategories", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleCategory" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/category/tree": { "get": { "tags": [ "article-category-controller" ], "summary": "Get list of article categories", "operationId": "getArticleCategoriesTree", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleCategory" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/article/advanced": { "get": { "tags": [ "article-advanced-controller" ], "summary": "Get list of articles using advanced filters", "operationId": "getArticlesAdvanced", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/allocations": { "get": { "tags": [ "allocation-controller" ], "summary": "Get list of allocation rules", "operationId": "getAllocationRules", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationRuleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/allocations/{id}": { "get": { "tags": [ "allocation-controller" ], "summary": "Get details of allocation rule", "operationId": "find_14", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationRule" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "allocation-controller" ], "summary": "Delete allocations rule", "operationId": "delete_22", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/allocations/rules-for-sales-invoice": { "get": { "tags": [ "allocation-controller" ], "summary": "Get list of allocation rules for sales invoices for organization of the current user", "operationId": "getPossibleRulesForSalesInvoices", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/allocations/rules-for-purchase-invoice": { "get": { "tags": [ "allocation-controller" ], "summary": "Get list of allocation rules for purchase invoices for organization of the current user", "operationId": "getPossibleRulesForPurchaseInvoices", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/allocations/overall": { "get": { "tags": [ "allocation-controller" ], "summary": "Get total results count for list of allocation rules", "operationId": "calculateResultCount_40", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/activity-log": { "get": { "tags": [ "activity-log-controller" ], "summary": "Get list of activity log events", "operationId": "getTableView_37", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityLogView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/activity-log/overall": { "get": { "tags": [ "activity-log-controller" ], "summary": "Get total results count for list of activity log", "operationId": "getResultsCount_1", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/activity-log/can-open-module/{id}/{type}": { "get": { "tags": [ "activity-log-controller" ], "summary": "Check if can open entity from activity log", "operationId": "getIdWhenOpenInModule_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period": { "get": { "tags": [ "accounting-period-controller" ], "summary": "Get list of accounting periods", "operationId": "getTableView_38", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Page Number", "schema": { "type": "integer", "default": 1 } }, { "name": "sortingField", "in": "query", "description": "Field to sort by", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "Sorting direction", "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "sizePerPage", "in": "query", "description": "Size per page", "schema": { "type": "integer", "default": 60 } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingPeriodView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/{id}": { "get": { "tags": [ "accounting-period-controller" ], "summary": "Get details of accounting period", "operationId": "find_15", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingPeriod" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } }, "delete": { "tags": [ "accounting-period-controller" ], "summary": "Delete accounting period", "operationId": "deleteAccountingPeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/vat-rule": { "get": { "tags": [ "accounting-period-controller" ], "summary": "Get VAT rules", "operationId": "getVatRules", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatRuleView" } } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/latest": { "get": { "tags": [ "accounting-period-controller" ], "summary": "Get details of latest opened accounting period", "operationId": "findLatestOpenPeriod", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingPeriod" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/latest-open-period-start-date": { "get": { "tags": [ "accounting-period-controller" ], "summary": "Get start date of latest opened accounting period", "operationId": "getLatestOpenPeriodStartDate", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/latest-end-date": { "get": { "tags": [ "accounting-period-controller" ], "summary": "Get latest end date of accounting periods", "operationId": "getLatestEndDate", "parameters": [ { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/accounting-period/date-lock-status/{date}": { "get": { "tags": [ "accounting-period-controller" ], "summary": "Check whether date is inside locked or unlocked accounting period", "operationId": "getDateLockStatus", "parameters": [ { "name": "date", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateLockStatus" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/timesheet/{id}/workflow": { "delete": { "tags": [ "timesheet-controller" ], "summary": "Delete timesheet from workflow", "operationId": "deleteFromWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/sales-invoice/{id}/workflow": { "delete": { "tags": [ "sales-invoice-controller" ], "summary": "Delete sales invoice from workflow", "operationId": "deleteFromWorkflow_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/purchase-invoice/{id}/workflow": { "delete": { "tags": [ "purchase-invoice-controller" ], "summary": "Delete purchase invoice from workflow", "operationId": "deleteFromWorkflow_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/orders/{id}/workflow": { "delete": { "tags": [ "order-controller" ], "summary": "Delete order from workflow", "operationId": "deleteFromWorkflow_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/my-timesheet/{id}": { "delete": { "tags": [ "my-timesheet-controller" ], "summary": "Delete my timesheet", "operationId": "deleteTimesheet_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/document/large-to-export/{id}": { "delete": { "tags": [ "large-document-export-controller" ], "summary": "Delete document file", "operationId": "removeDocument_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } }, "/api-v1/contact/{id}": { "delete": { "tags": [ "contact-controller" ], "summary": "Delete contact", "operationId": "deleteContact", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "WEAL-TOKEN", "in": "header", "description": "API token (can be retrieved from account settings)", "required": true, "schema": { "type": "string" } }, { "name": "TARGET-ORGANIZATION-ID", "in": "header", "description": "ID of organization, for which the operation must be performed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } } }, "400": { "description": "400 Bad Request" }, "401": { "description": "401 Unauthorized" }, "403": { "description": "403 Access Denied" }, "404": { "description": "404 Not Found" }, "500": { "description": "500 Internal Server Error" } } } } }, "components": { "schemas": { "Absence": { "required": [ "employeeId", "fromDate", "hours", "type" ], "type": "object", "properties": { "id": { "type": "integer" }, "employeeId": { "type": "integer" }, "fromDate": { "type": "string" }, "toDate": { "type": "string" }, "type": { "type": "string", "enum": [ "VACATION", "ACCIDENT", "SICKNESS", "MOVING_HOUSE", "MARRIAGE", "CHILD_BIRTH", "MOURNING", "ARMY_CIVIL_PROTECTION", "OTHER" ] }, "hours": { "type": "number" }, "comment": { "type": "string" } } }, "BatchUpdateResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BatchUpdateResponseItem" } } } }, "BatchUpdateResponseItem": { "type": "object", "properties": { "errorCode": { "$ref": "#/components/schemas/ErrorCode" }, "freshRow": { "type": "object" }, "freshData": { "type": "object" }, "possibleWorkflows": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/WorkflowBrief" } }, "error": { "type": "boolean" }, "severeError": { "type": "boolean" } } }, "ErrorCode": { "type": "object", "properties": { "errorCode": { "type": "string", "enum": [ "NO_ERROR", "NOT_IMPLEMENTED_YET", "CONTACT_NOT_FOUND", "FIELD_REQUIRED", "VALIDATION_ERROR", "DUPLICATION_ERROR", "UNIQUE_CONSTRAINT_VIOLATION", "WRONG_PASSWORD_FORMAT", "WRONG_PASSWORD", "ACTION_DENIED", "NOT_FOUND", "EXPECTED_ONE_FILE", "UNIQUE_VIOLATION", "CONTENT_EMPTY", "INVALID_TYPE", "CONVERSION_ERROR", "FILE_PARSE_EXCEPTION", "IN_USE" ] }, "errorDetailValues": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetails" } } } }, "ErrorDetails": { "type": "object", "properties": { "errorCode": { "type": "string" }, "fieldName": { "type": "string" }, "data": { "type": "string" }, "isSevere": { "type": "boolean" } } }, "WorkflowBrief": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "NewOtherEmployeeTimeEntry": { "required": [ "clientId", "date", "employeeId", "orderId" ], "type": "object", "properties": { "description": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "REJECTED", "APPROVED", "BILLED" ] }, "isBillable": { "type": "boolean" }, "date": { "type": "string" }, "time": { "pattern": "^(\\d+[.]\\d{2})|$", "type": "string" }, "clientId": { "type": "integer" }, "employeeId": { "type": "integer" }, "orderId": { "type": "integer" }, "taskId": { "type": "integer" } } }, "UpdateResponse": { "type": "object", "properties": { "data": { "type": "object" }, "error": { "$ref": "#/components/schemas/ErrorCode" }, "valid": { "type": "boolean" } } }, "SplitPayment": { "required": [ "valueDate" ], "type": "object", "properties": { "receivableByAccountId": { "type": "integer" }, "valueDate": { "type": "string" }, "requestedAmount": { "type": "string" }, "paidAmount": { "type": "string" }, "bankCharges": { "type": "string" }, "lossOnDebtors": { "type": "string" } } }, "ReportTemplateLine": { "type": "object", "properties": { "reportType": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "CASH_FLOW", "RATIOS" ] } }, "discriminator": { "propertyName": "reportType" } }, "StaticTemplateLine": { "required": [ "templateLineIds" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ReportTemplateLine" }, { "type": "object", "properties": { "id": { "type": "integer" }, "lineType": { "type": "string", "enum": [ "PROFIT_FOR_PERIOD", "DEPRECIATION_AND_IMPAIRMENT_LOSSES_ON_PROPERTY_AND_PLANT_AND_EQUIPMENT", "DEPRECIATION_ON_INVESTMENTS", "CHANGE_IN_OTHER_SHORT_TERM_RECEIVABLES", "CHANGE_IN_PRE_PAID_EXPENSES_AND_ACCRUED_INCOME", "CHANGE_IN_TRADE_ACCOUNT_PAYABLE", "CHANGE_IN_OTHER_SHORT_TERM_LIABILITIES", "CHANGE_IN_ACCRUED_EXPENSES_AND_DEFERRED_INCOME", "CHANGE_IN_PROVISIONS_FOR_TAXES", "CHANGE_IN_CASH_FLOW_RELATED_TO_INVESTMENTS", "CHANGE_IN_CASH_FLOW_RELATED_TO_FINANCING_ACTIVITIES", "CASH_POSITION", "TOTAL_OVERHEAD_COSTS", "CASH_POSITION_AT_START_DATE", "CASH_POSITION_AT_END_DATE", "CHANGE_IN_CASH_FLOW_RELATED_TO_OPERATIONAL_ACTIVITIES", "NET_CASH_CHANGE_1", "NET_CASH_CHANGE_2", "CASH_AND_CASH_EQUIVALENTS", "ACCOUNTS_RECEIVABLE", "CURRENT_LIABILITIES", "TOTAL_REVENUE", "GROSS_PROFIT", "NET_PROFIT", "SHORT_TERM_INVESTMENTS", "CURRENT_ASSETS", "TOTAL_ASSETS", "TOTAL_LIABILITIES", "LONG_TERM_DEBT", "SHAREHOLDER_S_EQUITY", "INVENTORY", "COST_OF_GOODS_SOLD", "EARNINGS_BEFORE_INTEREST_AND_TAX", "INTEREST_EXPENSE" ] }, "templateLineIds": { "type": "array", "items": { "type": "integer" } } } } ] }, "TemplateLine": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ReportTemplateLine" }, { "type": "object", "properties": { "id": { "type": "integer" }, "parentId": { "type": "integer" }, "position": { "type": "integer", "format": "int32" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateLine" } }, "content": { "type": "array", "items": { "type": "object" } }, "localizations": { "$ref": "#/components/schemas/TranslationEntity" }, "lineType": { "type": "string", "enum": [ "NONE", "ACCOUNTS", "CALCULATIONS" ] }, "lineSign": { "type": "string", "enum": [ "ASSETS", "LIABILITY", "INCOME", "EXPENSE" ] }, "isPercentage": { "type": "boolean" }, "warnings": { "type": "string" }, "organizationId": { "type": "integer" }, "appendixReference": { "type": "array", "items": { "type": "integer" } } } } ] }, "TranslationEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "en": { "type": "string" }, "fr": { "type": "string" }, "de": { "type": "string" }, "it": { "type": "string" } } }, "Amount": { "type": "object", "properties": { "id": { "type": "integer" }, "vatRateId": { "type": "integer" }, "amountType": { "type": "string", "enum": [ "NO_VAT", "VAT_RATE", "MANUAL" ] }, "net": { "type": "string" }, "vat": { "type": "string" }, "vatType": { "type": "string", "enum": [ "NO_VAT", "NATIVE", "IMPORT_OF_SERVICE" ] }, "vatTypeCodeId": { "type": "integer" } } }, "ContactBrief": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "Document": { "required": [ "date", "entityId", "fileId", "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "entityId": { "type": "integer" }, "name": { "type": "string" }, "fileId": { "type": "integer" }, "date": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTagEntity" } }, "contact": { "$ref": "#/components/schemas/ContactBrief" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "comments": { "type": "string" }, "createdBy": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "fileExtension": { "type": "string" }, "size": { "type": "integer" }, "isSystem": { "type": "boolean" }, "self": { "type": "boolean" } } }, "DocumentTagEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "PurchaseInvoiceScan": { "required": [ "currencyId", "date", "supplierId" ], "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "date": { "type": "string" }, "supplierId": { "type": "integer" }, "currencyId": { "type": "integer" }, "reference": { "type": "string" }, "description": { "type": "string" }, "comment": { "type": "string" }, "validated": { "type": "boolean" }, "vatType": { "type": "string", "enum": [ "NO_VAT", "NATIVE", "IMPORT_OF_SERVICE" ] }, "vatTypeCodeId": { "type": "integer" }, "amounts": { "type": "array", "items": { "$ref": "#/components/schemas/Amount" } }, "attributions": { "type": "array", "items": { "$ref": "#/components/schemas/ScanAttribution" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ScanPayment" } }, "document": { "$ref": "#/components/schemas/Document" }, "warnings": { "type": "string" }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "paymentChartId": { "type": "integer" }, "status": { "type": "string", "enum": [ "NEW", "PROCESS", "CONVERT", "RECOGNIZING" ] }, "isOrganizationNameIncluded": { "type": "boolean" }, "isTreatedByManagingOrganization": { "type": "boolean" } } }, "ScanAttribution": { "required": [ "chartOfAccountsId", "dateFrom", "dateTo" ], "type": "object", "properties": { "id": { "type": "integer" }, "chartOfAccountsId": { "type": "integer" }, "dateFrom": { "type": "string" }, "dateTo": { "type": "string" }, "net": { "type": "string" }, "percent": { "type": "string" }, "departmentId": { "type": "integer" }, "orderId": { "type": "integer" }, "orderIdToDisplay": { "type": "string" }, "reBillDate": { "type": "string", "format": "date-time" }, "reBill": { "type": "boolean" }, "articleId": { "type": "integer" }, "quantity": { "type": "string" }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/ScanShipment" } }, "appliedAllocationRules": { "type": "array", "items": { "type": "string" } }, "officeId": { "type": "integer" }, "readOnly": { "type": "boolean" } } }, "ScanPayment": { "required": [ "paymentType", "requestedDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "requestedDate": { "type": "string" }, "plannedDate": { "type": "string" }, "sentDate": { "type": "string" }, "valueDate": { "type": "string" }, "requestedAmount": { "type": "string" }, "paidAmount": { "type": "string" }, "bankCharges": { "type": "string" }, "payableByAccountId": { "type": "integer" }, "paymentType": { "type": "string", "enum": [ "BANK_TRANSFER", "BVR", "QR_BILL" ] }, "payableToBankId": { "type": "integer" }, "lineCode": { "type": "string" }, "accountNumber": { "type": "string" }, "referenceNumber": { "type": "string" }, "qrBillData": { "type": "string" }, "isFromLockedAccountingPeriod": { "type": "boolean" } } }, "ScanShipment": { "type": "object", "properties": { "id": { "type": "integer" }, "shipmentDate": { "type": "string" }, "articleId": { "type": "integer" }, "quantity": { "type": "string" }, "currencyCode": { "type": "string" }, "totalCost": { "type": "number" }, "generatedStockMovementId": { "type": "integer" }, "articleName": { "$ref": "#/components/schemas/Translation" }, "articleIdSku": { "type": "string" }, "attributionId": { "type": "integer" } } }, "Translation": { "type": "object", "properties": { "en": { "type": "string" }, "fr": { "type": "string" }, "de": { "type": "string" }, "it": { "type": "string" } } }, "DocumentFile": { "type": "object", "properties": { "id": { "type": "integer" }, "fileExtension": { "type": "string" }, "size": { "type": "integer" }, "name": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "organizationId": { "type": "integer" } } }, "PdfTemplate": { "required": [ "name", "sourceTemplate" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "templateType": { "type": "string", "enum": [ "SALES_INVOICE", "LATE_NOTICE", "SALARY_SLIP", "MY_SALARY_SLIP", "SALES_ORDER", "VAT_REPORT", "DELIVERY_NOTE", "GENERAL_LEDGER" ] }, "countryId": { "type": "integer" }, "sourceTemplate": { "$ref": "#/components/schemas/DocumentFile" }, "previewTemplate": { "$ref": "#/components/schemas/DocumentFile" }, "previewImage": { "$ref": "#/components/schemas/DocumentFile" }, "isActive": { "type": "boolean" }, "description": { "type": "string" } } }, "OrganizationCurrencyExchange": { "required": [ "currencyFrom", "currencyTo", "date", "rate" ], "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "date": { "type": "string" }, "currencyFrom": { "type": "integer" }, "currencyTo": { "type": "integer" }, "rate": { "type": "number" } } }, "Address": { "required": [ "countryId", "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "$ref": "#/components/schemas/Region" }, "countryCode2": { "type": "string" }, "postCode": { "type": "string" }, "toTheAttentionOf": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "houseNumber": { "type": "string" }, "countryId": { "type": "integer" }, "service": { "type": "string" }, "readOnly": { "type": "boolean" } } }, "Bank": { "required": [ "chartOfAccounts", "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "qrIban": { "type": "string" }, "isrCustomerNumber": { "type": "string" }, "bankCustomerNumber": { "pattern": "^([1-9][0-9]*)*$", "type": "string" }, "swiftBic": { "type": "string" }, "bankName": { "type": "string" }, "remark": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "useForReconciliation": { "type": "boolean" }, "chartOfAccounts": { "type": "integer" }, "accountHolderAddress": { "$ref": "#/components/schemas/Address" }, "customHolder": { "type": "boolean" } } }, "MyAccount": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "nationalityCountryId": { "type": "integer" }, "birthday": { "type": "string" }, "gender": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "defaultLanguage": { "type": "string", "enum": [ "EN", "FR", "DE", "IT", "UNDEFINED" ] }, "phone": { "type": "string" }, "fax": { "type": "string" }, "mobile": { "type": "string" }, "email": { "type": "string" }, "webSite": { "type": "string" }, "warnings": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "banks": { "type": "array", "items": { "$ref": "#/components/schemas/Bank" } }, "avatarId": { "type": "integer" }, "defaultModule": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "licenceType": { "type": "string", "enum": [ "FREE", "PREMIUM" ] }, "archived": { "type": "boolean" }, "isFreeTier": { "type": "boolean" }, "pdfPassword": { "type": "string" }, "ecorrespondence": { "type": "boolean" } } }, "Region": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "taxMode": { "type": "string", "enum": [ "ANNUALLY", "MONTHLY" ] } } }, "CurrencyExchange": { "required": [ "currencyFrom", "currencyTo", "date", "rate" ], "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string" }, "currencyFrom": { "type": "integer" }, "currencyTo": { "type": "integer" }, "rate": { "type": "number" } } }, "ChartOfAccounts": { "required": [ "accountNumber", "currencyId", "startDate", "type" ], "type": "object", "properties": { "id": { "type": "integer" }, "currencyId": { "type": "integer" }, "businessUnitId": { "type": "integer" }, "accountNumber": { "pattern": "^([1-9][0-9]*)*$", "type": "string" }, "organizationId": { "type": "integer" }, "localizations": { "$ref": "#/components/schemas/TranslationEntity" }, "type": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "SYSTEM" ] }, "isActive": { "type": "boolean" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "isPurchaseInvoicesEnabled": { "type": "boolean" }, "isSalesInvoicesEnabled": { "type": "boolean" }, "isExpenseReportEnabled": { "type": "boolean" }, "isCashAccountEnabled": { "type": "boolean" }, "isPaymentMethodEnabled": { "type": "boolean" }, "isFXAutoAdjustmentEnabled": { "type": "boolean" }, "isBusinessUnitSplitEnabled": { "type": "boolean" }, "warnings": { "type": "string" }, "immobilizationChartOfAccountId": { "type": "integer" }, "immobilizationType": { "type": "string", "enum": [ "LINEAR_DEPRECIATION_DIRECT", "NON_LINEAR_DEPRECIATION_DIRECT", "LINEAR_DEPRECIATION_INDIRECT", "NON_LINEAR_DEPRECIATION_INDIRECT" ] } } }, "Budget": { "required": [ "name", "period" ], "type": "object", "properties": { "id": { "type": "integer" }, "parent": { "type": "integer" }, "period": { "$ref": "#/components/schemas/BudgetPeriod" }, "name": { "type": "string" }, "reportType": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "CASH_FLOW", "RATIOS" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "department": { "type": "integer" }, "article": { "type": "integer" }, "contact": { "type": "integer" }, "orderId": { "type": "integer" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetEntry" } }, "warnings": { "type": "string" }, "officeId": { "type": "integer" }, "isReadOnly": { "type": "boolean" } } }, "BudgetEntry": { "type": "object", "properties": { "id": { "type": "integer" }, "reportLine": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "newValue": { "type": "string", "writeOnly": true }, "value": { "type": "string" }, "total": { "type": "number" }, "chart": { "type": "integer" }, "hasChildBudget": { "type": "boolean" } } }, "BudgetPeriod": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer" }, "fiscalYear": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } } }, "ArticleCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "parentCategoryId": { "type": "integer" }, "organizationId": { "type": "integer" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleCategory" } } } }, "Workflow": { "required": [ "moduleType", "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "moduleType": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowBlock" } }, "isActive": { "type": "boolean" } } }, "WorkflowBlock": { "required": [ "actionType", "blockType" ], "type": "object", "properties": { "id": { "type": "integer" }, "position": { "type": "integer" }, "blockType": { "type": "string", "enum": [ "TRIGGER", "ACTION" ] }, "actionType": { "type": "string", "enum": [ "ADVANCED_INVOICING", "CREATE", "DELETE", "GENERATE_PAYMENT", "GENERATE_PDF_SEND", "MODIFY", "NONE", "SEND_CONFIRMATION", "SEND_OFFER", "STATUS_BILLABLE", "STATUS_CONFIRMED", "SUBMIT", "VALIDATE" ] }, "userGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "users": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } }, "users2": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } }, "userGroupIds2": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "isSystemUserGroup": { "type": "boolean" }, "isSystemUserGroup2": { "type": "boolean" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } }, "canModify": { "type": "boolean" }, "filters": { "type": "string" }, "generateParams": { "type": "string" } } }, "Widget": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "contactId": { "type": "integer" }, "templateNumber": { "type": "integer", "format": "int32" }, "x": { "type": "integer", "format": "int32" }, "y": { "type": "integer", "format": "int32" }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "TREASURY", "PL_STATEMENT", "CASH_FLOW_STATEMENT", "GROSS_MARGIN", "NET_MARGIN", "AVERAGE_RECEIVABLES", "AVERAGE_PAYABLES", "AVERAGE_WEIGHTED_RECEIVABLES", "AVERAGE_WEIGHTED_PAYABLES", "LIQUIDITY_RATIO", "PAYABLES", "VAT", "INVOICES_FOR_REVIEW", "CASH_FLOW_CHART", "OUTSTANDING_RECEIVABLES", "FUTURE_PAYABLES", "INCOME_BREAKDOWN", "EXPENSE_BREAKDOWN", "MONTHLY_INCOME_EXPENSE", "PURCHASE_INVOICE_SCANS_UPLOAD", "INVOICE_SCANS", "ANNUAL_EMPLOYEE_COUNT", "NOTIFICATIONS", "WORKING_CAPITAL_REQUIREMENT", "DOCUMENT_SCANS", "ALERTS_ON_REGISTRY_OF_COMMERCE", "LINES_TO_BE_RECONCILED", "ACTIVE_USERS", "MONTHLY_LIQUIDITY" ] }, "isRemoved": { "type": "boolean" }, "filters": { "type": "string" } } }, "VatReportSubmit": { "required": [ "date", "reportEndDate", "reportStartDate" ], "type": "object", "properties": { "date": { "type": "string" }, "file": { "type": "string", "format": "binary" }, "reportStartDate": { "type": "string" }, "reportEndDate": { "type": "string" } } }, "Response": { "type": "object" }, "BriefRole": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "roleType": { "type": "string", "enum": [ "ORGANIZATION", "GLOBAL" ] } } }, "UserGroup": { "required": [ "name", "type" ], "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "GROUP", "SUPER_GROUP" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "userIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "groupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "roles": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/BriefRole" } }, "globalRoles": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/BriefRole" } }, "isAdvanced": { "type": "boolean" }, "rule": { "type": "string" } } }, "TimesheetDetails": { "required": [ "date", "time" ], "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "REJECTED", "APPROVED", "BILLED" ] }, "employee": { "type": "string" }, "client": { "type": "string" }, "order": { "type": "string" }, "task": { "type": "string" }, "description": { "type": "string" }, "time": { "pattern": "^(\\d+[.]\\d{2})|$", "type": "string" }, "isBillable": { "type": "boolean" }, "billableRate": { "type": "number" }, "billableAmount": { "type": "number" }, "costRate": { "type": "number" }, "departmentId": { "type": "integer" }, "officeId": { "type": "integer" } } }, "SalesInvoiceUserValidatedView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "number": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "client": { "type": "string" }, "clientId": { "type": "integer" }, "reference": { "type": "string" }, "description": { "type": "string" }, "referenceAndDescriptionJoined": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "receivable": { "type": "number" }, "status": { "type": "string", "enum": [ "OPEN", "UNPAID", "PAID", "PARTIALLY_PAID", "OVERDUE", "PRO_FORMA" ] }, "comments": { "type": "string" }, "warnings": { "type": "string" }, "ourContactName": { "type": "string" }, "clientEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "bvrGenerationAvailability": { "type": "boolean" }, "qrGenerationAvailability": { "type": "boolean" }, "creatorContactId": { "type": "integer" }, "validated": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "hasComments": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "clientBillingEmail": { "type": "string" }, "hasShipments": { "type": "boolean" }, "isDocSent": { "type": "boolean" }, "validatorUserIdsSize": { "type": "integer" }, "realValidated": { "type": "boolean" }, "validatorUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "inWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" } } }, "SalesInvoiceView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "number": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "client": { "type": "string" }, "clientId": { "type": "integer" }, "reference": { "type": "string" }, "description": { "type": "string" }, "referenceAndDescriptionJoined": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "receivable": { "type": "number" }, "status": { "type": "string", "enum": [ "OPEN", "UNPAID", "PAID", "PARTIALLY_PAID", "OVERDUE", "PRO_FORMA" ] }, "comments": { "type": "string" }, "warnings": { "type": "string" }, "ourContactName": { "type": "string" }, "clientEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "bvrGenerationAvailability": { "type": "boolean" }, "qrGenerationAvailability": { "type": "boolean" }, "creatorContactId": { "type": "integer" }, "validated": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "hasComments": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "clientBillingEmail": { "type": "string" }, "hasShipments": { "type": "boolean" }, "isDocSent": { "type": "boolean" }, "inWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" } } }, "StockMovementLine": { "required": [ "currencyId", "date", "movementDirection", "type" ], "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string" }, "movementDirection": { "type": "string", "enum": [ "IN", "OUT" ] }, "type": { "type": "string", "enum": [ "MANUAL", "SHIPMENT" ] }, "articleId": { "type": "integer" }, "ean": { "type": "string" }, "quantity": { "type": "string" }, "currencyId": { "type": "integer" }, "cost": { "type": "string" }, "comment": { "type": "string" }, "quantityLeft": { "type": "number" }, "organizationId": { "type": "integer" }, "departmentId": { "type": "integer" }, "contactId": { "type": "integer" }, "orderId": { "type": "integer" }, "officeId": { "type": "integer" } } }, "InvoiceTimesheetInfo": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string" }, "description": { "type": "string" }, "time": { "type": "string" }, "billableAmount": { "type": "string" }, "billableRate": { "type": "string" }, "employeeContactId": { "type": "integer" }, "originalTimesheetId": { "type": "integer" }, "employeeTaskId": { "type": "integer" } } }, "OrderShipment": { "type": "object", "properties": { "id": { "type": "integer" }, "shipmentDate": { "type": "string" }, "articleId": { "type": "integer" }, "quantity": { "type": "string" }, "currencyCode": { "type": "string" }, "totalCost": { "type": "number" }, "generatedStockMovementId": { "type": "integer" }, "articleName": { "$ref": "#/components/schemas/Translation" }, "articleIdSku": { "type": "string" }, "orderArticleId": { "type": "integer" }, "salesInvoiceLineId": { "type": "integer" } } }, "SalesInvoice": { "required": [ "clientId", "currencyId", "date", "invoiceLines" ], "type": "object", "properties": { "id": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "number": { "type": "string" }, "date": { "type": "string" }, "clientId": { "type": "integer" }, "clientAddressId": { "type": "integer" }, "address": { "$ref": "#/components/schemas/Address" }, "ourContactId": { "type": "integer" }, "yourContactId": { "type": "integer" }, "clientName": { "type": "string" }, "reference": { "type": "string" }, "yourReference": { "type": "string" }, "currencyId": { "type": "integer" }, "description": { "type": "string" }, "comments": { "type": "string" }, "warnings": { "type": "string" }, "receivableAccountId": { "type": "integer" }, "vatTypeCodeId": { "type": "integer" }, "excludedFromVat": { "type": "boolean" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceLine" } }, "invoiceLinesLayout": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceLineLayout" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPayment" } }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderShipment" } }, "timesheetInfoItems": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTimesheetInfo" } }, "sourceOrderId": { "type": "integer" }, "sourceSubOrderId": { "type": "integer" }, "bvrGenerationAvailability": { "type": "boolean" }, "qrGenerationAvailability": { "type": "boolean" }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "isContainsFixedAsset": { "type": "boolean" }, "accrualFrom": { "type": "string" }, "accrualTo": { "type": "string" }, "accrualEntriesAmount": { "type": "integer", "format": "int32" }, "validated": { "type": "boolean" }, "validatorUserIdsSize": { "type": "integer" }, "validatorUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "realValidated": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "canEditProformaFlag": { "type": "boolean" }, "isDocSent": { "type": "boolean", "readOnly": true }, "proforma": { "type": "boolean" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } } }, "SalesInvoiceLine": { "required": [ "discount", "netUnitPrice", "quantity", "saleAccountId", "totalNet" ], "type": "object", "properties": { "id": { "type": "integer" }, "tempId": { "type": "integer" }, "lineType": { "type": "string", "enum": [ "ARTICLE", "NO_ARTICLE", "TIMESHEET", "EXPENSES", "DISBURSEMENT", "HEADER", "FIXED_ASSET" ] }, "quantity": { "type": "number" }, "articleId": { "type": "integer" }, "isArticleShipped": { "type": "boolean" }, "description": { "type": "string" }, "longDescription": { "type": "string" }, "netUnitPrice": { "type": "number" }, "discount": { "type": "number" }, "totalNet": { "type": "number" }, "vatRateId": { "type": "integer" }, "vat": { "type": "number" }, "totalPrice": { "type": "number" }, "saleAccountId": { "type": "integer" }, "departmentId": { "type": "integer" }, "allocationKey": { "type": "string" }, "appliedAllocationRules": { "type": "array", "items": { "type": "string" } }, "vatTypeCodeId": { "type": "integer" }, "articleName": { "$ref": "#/components/schemas/Translation" }, "saleAccountName": { "$ref": "#/components/schemas/Translation" }, "departmentName": { "type": "string" }, "fixedAssetName": { "type": "string" }, "fixedAssetId": { "type": "integer" }, "officeId": { "type": "integer" }, "officeName": { "type": "string" } } }, "SalesInvoiceLineLayout": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" }, "position": { "type": "integer", "format": "int32" }, "lineType": { "type": "string", "enum": [ "ARTICLE", "NO_ARTICLE", "TIMESHEET", "EXPENSES", "DISBURSEMENT", "HEADER", "FIXED_ASSET" ] }, "salesInvoiceLineId": { "type": "integer" }, "sourceOrderId": { "type": "integer" } } }, "SalesPayment": { "required": [ "overdueDate", "receivableByAccountId", "requestedDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "receivableByAccountId": { "type": "integer" }, "requestedDate": { "type": "string" }, "overdueDate": { "type": "string" }, "valueDate": { "type": "string" }, "sentDate": { "type": "string" }, "requestedAmount": { "type": "string" }, "paidAmount": { "type": "string" }, "bankCharges": { "type": "string" }, "lossOnDebtors": { "type": "string" }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "qrBillData": { "type": "string" }, "receivableByAccountName": { "$ref": "#/components/schemas/Translation" }, "qrReferenceNumber": { "type": "string", "writeOnly": true } } }, "Permission": { "type": "object", "properties": { "id": { "type": "integer" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "sub0": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "sub1": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "sub2": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "canView": { "type": "boolean" }, "canCreate": { "type": "boolean" }, "canModify": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canExport": { "type": "boolean" }, "viewType": { "type": "string", "enum": [ "NONE", "ALL", "OWNER", "WORKFLOW" ] }, "modifyType": { "type": "string", "enum": [ "NONE", "ALL", "OWNER", "WORKFLOW" ] }, "deleteType": { "type": "string", "enum": [ "NONE", "ALL", "OWNER", "WORKFLOW" ] } } }, "Role": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "ROLE", "SUPER_ROLE" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "global": { "type": "boolean" } }, "discriminator": { "propertyName": "type" } }, "RoleWithPermissions": { "required": [ "name", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Role" }, { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } ] }, "SuperRole": { "required": [ "name", "roles", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Role" }, { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleWithPermissions" } } } } ] }, "ReconcileResponse": { "type": "object", "properties": { "reconciledLines": { "type": "array", "items": { "type": "integer" } }, "notReconciledLines": { "type": "array", "items": { "type": "integer" } } } }, "ReconciliationUploadResult": { "type": "object", "properties": { "linesGenerated": { "type": "array", "items": { "type": "integer" } }, "numberOfManualLines": { "type": "integer", "format": "int32" }, "numberOfJournalEntriesGenerated": { "type": "integer", "format": "int32" }, "reconcileResponse": { "$ref": "#/components/schemas/ReconcileResponse" } } }, "ReconcileRequest": { "type": "object", "properties": { "lineIdsToReconcile": { "type": "array", "items": { "type": "integer" } } } }, "ReconciliationLine": { "type": "object", "properties": { "id": { "type": "integer" }, "processDate": { "type": "string", "format": "date-time" }, "movementDirection": { "type": "string", "enum": [ "IN", "OUT" ] }, "contactId": { "type": "integer" }, "reference": { "type": "string" }, "valueDate": { "type": "string", "format": "date-time" }, "paidCurrencyId": { "type": "integer" }, "paidAmount": { "type": "number" }, "isReconciled": { "type": "boolean" }, "mainAccountIban": { "type": "string" }, "mainAccountId": { "type": "integer" }, "isInternalContact": { "type": "boolean" }, "manualEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ReconciliationManualEntry" } } } }, "ReconciliationManualEntry": { "type": "object", "properties": { "id": { "type": "integer" }, "paymentType": { "type": "string", "enum": [ "SALES_INVOICE", "PURCHASE_INVOICE", "SALARY_SLIP", "MANUAL" ] }, "description": { "type": "string" }, "amount": { "type": "string" }, "requestedAmount": { "type": "string" }, "counterPartyAccountId": { "type": "integer" }, "amountInCurrency": { "type": "string" }, "entityContactId": { "type": "integer" }, "currencyId": { "type": "integer" }, "purchasePaymentId": { "type": "integer" }, "salesPaymentId": { "type": "integer" }, "payrollPaymentId": { "type": "integer" }, "departmentId": { "type": "integer" }, "isSplitPayment": { "type": "boolean" }, "bankCharges": { "type": "number" }, "lossOnDebtors": { "type": "number" }, "officeId": { "type": "integer" } } }, "Attribution": { "required": [ "chartOfAccountsId", "dateFrom", "dateTo" ], "type": "object", "properties": { "id": { "type": "integer" }, "chartOfAccountsId": { "type": "integer" }, "dateFrom": { "type": "string" }, "dateTo": { "type": "string" }, "net": { "type": "string" }, "percent": { "type": "string" }, "departmentId": { "type": "integer" }, "orderId": { "type": "integer" }, "orderIdToDisplay": { "type": "string" }, "orderClientId": { "type": "integer" }, "reBillDate": { "type": "string", "format": "date-time" }, "reBill": { "type": "boolean" }, "articleId": { "type": "integer" }, "quantity": { "type": "string" }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseInvoiceShipment" } }, "appliedAllocationRules": { "type": "array", "items": { "type": "string" } }, "chartOfAccountsName": { "$ref": "#/components/schemas/Translation" }, "departmentName": { "type": "string" }, "articleName": { "$ref": "#/components/schemas/Translation" }, "fixedAssetName": { "type": "string" }, "fixedAssetId": { "type": "integer" }, "officeId": { "type": "integer" }, "officeName": { "type": "string" }, "readOnly": { "type": "boolean" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } } }, "PurchaseInvoice": { "required": [ "amounts", "currencyId", "date", "payments", "reference", "supplierId" ], "type": "object", "properties": { "id": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "organizationId": { "type": "integer" }, "date": { "type": "string" }, "supplierId": { "type": "integer" }, "currencyId": { "type": "integer" }, "reference": { "type": "string" }, "description": { "type": "string" }, "comment": { "type": "string" }, "validated": { "type": "boolean" }, "vatType": { "type": "string", "enum": [ "NO_VAT", "NATIVE", "IMPORT_OF_SERVICE" ] }, "vatTypeCodeId": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "amounts": { "type": "array", "items": { "$ref": "#/components/schemas/Amount" } }, "attributions": { "type": "array", "items": { "$ref": "#/components/schemas/Attribution" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/PurchasePayment" } }, "warnings": { "type": "string" }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "accrualEntriesAmount": { "type": "integer", "format": "int32" }, "isDraft": { "type": "boolean" }, "validatorUserIdsSize": { "type": "integer" }, "validatorUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "realValidated": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "isContainsSoldFixedAsset": { "type": "boolean" } } }, "PurchaseInvoiceShipment": { "type": "object", "properties": { "id": { "type": "integer" }, "shipmentDate": { "type": "string" }, "articleId": { "type": "integer" }, "quantity": { "type": "string" }, "currencyCode": { "type": "string" }, "totalCost": { "type": "number" }, "generatedStockMovementId": { "type": "integer" }, "articleName": { "$ref": "#/components/schemas/Translation" }, "articleIdSku": { "type": "string" }, "attributionId": { "type": "integer" }, "departmentId": { "type": "integer" }, "officeId": { "type": "integer" } } }, "PurchasePayment": { "required": [ "paymentType", "requestedDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "requestedDate": { "type": "string" }, "plannedDate": { "type": "string" }, "sentDate": { "type": "string" }, "valueDate": { "type": "string" }, "requestedAmount": { "type": "string" }, "paidAmount": { "type": "string" }, "bankCharges": { "type": "string" }, "payableByAccountId": { "type": "integer" }, "paymentType": { "type": "string", "enum": [ "BANK_TRANSFER", "BVR", "QR_BILL" ] }, "payableToBankId": { "type": "integer" }, "lineCode": { "type": "string" }, "accountNumber": { "type": "string" }, "referenceNumber": { "type": "string" }, "qrBillData": { "type": "string" }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "payableByAccountName": { "$ref": "#/components/schemas/Translation" }, "paymentPurposeCodeId": { "type": "integer" } } }, "CopySalaryConfigurationRequest": { "required": [ "calendarYear" ], "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "calendarYear": { "type": "integer", "format": "int32" } } }, "BothLine": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SystemLine" }, { "type": "object", "properties": { "payslipValueType": { "type": "string", "enum": [ "VALUE", "PERCENTAGE" ] }, "payslipValueSplitType": { "type": "string", "enum": [ "EMPLOYEE", "EMPLOYER", "BOTH" ] }, "isLimitSelected": { "type": "boolean" }, "isGenderSelected": { "type": "boolean" }, "isAgeSelected": { "type": "boolean" }, "genderType": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "isAnnualAdjustmentSelected": { "type": "boolean" }, "adjustmentLine": { "type": "integer" } } } ] }, "CalculationLine": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SystemLine" }, { "type": "object", "properties": { "payslipValueType": { "type": "string", "enum": [ "VALUE", "PERCENTAGE" ] }, "payslipValueSplitType": { "type": "string", "enum": [ "EMPLOYEE", "EMPLOYER", "BOTH" ] }, "isLimitSelected": { "type": "boolean" }, "isGenderSelected": { "type": "boolean" }, "isAgeSelected": { "type": "boolean" }, "genderType": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "isAnnualAdjustmentSelected": { "type": "boolean" }, "adjustmentLine": { "type": "integer" }, "employeeAmount": { "type": "number" }, "employeePercentage": { "type": "number" }, "employerAmount": { "type": "number" }, "employerPercentage": { "type": "number" }, "lowerLimit": { "type": "number" }, "upperLimit": { "type": "number" }, "limitCalculationType": { "type": "string", "enum": [ "TOTAL", "OVER_THE_LOWER_LIMIT" ] }, "minAge": { "type": "number" }, "maxAge": { "type": "number" }, "minAgeBarrier": { "type": "string", "enum": [ "PREVIOUS_YEAR", "CURRENT_YEAR", "FOLLOWING_YEAR", "PREVIOUS_MONTH", "CURRENT_MONTH", "FOLLOWING_MONTH", "EXACT_DATE" ] }, "maxAgeBarrier": { "type": "string", "enum": [ "PREVIOUS_YEAR", "CURRENT_YEAR", "FOLLOWING_YEAR", "PREVIOUS_MONTH", "CURRENT_MONTH", "FOLLOWING_MONTH", "EXACT_DATE" ] } } } ] }, "CompanyLine": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SystemLine" }, { "type": "object", "properties": { "payslipValueType": { "type": "string", "enum": [ "VALUE", "PERCENTAGE" ] }, "payslipValueSplitType": { "type": "string", "enum": [ "EMPLOYEE", "EMPLOYER", "BOTH" ] }, "isLimitSelected": { "type": "boolean" }, "isGenderSelected": { "type": "boolean" }, "isAgeSelected": { "type": "boolean" }, "genderType": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "isAnnualAdjustmentSelected": { "type": "boolean" }, "adjustmentLine": { "type": "integer" } } } ] }, "EmployeeLine": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SystemLine" }, { "type": "object", "properties": { "payslipValueType": { "type": "string", "enum": [ "VALUE", "PERCENTAGE" ] }, "payslipValueSplitType": { "type": "string", "enum": [ "EMPLOYEE", "EMPLOYER", "BOTH" ] } } } ] }, "Holiday": { "required": [ "date", "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string" }, "name": { "type": "string" } } }, "Payslip": { "required": [ "calendarYear", "countryId", "endDate", "startDate", "type" ], "type": "object", "properties": { "id": { "type": "integer" }, "parentPayslipId": { "type": "integer" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "calendarYear": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer" }, "countryName": { "$ref": "#/components/schemas/Translation" }, "countryCode": { "type": "string" }, "isRegionAvailable": { "type": "boolean" }, "type": { "type": "string", "enum": [ "COUNTRY", "REGION", "CLA" ] }, "region": { "$ref": "#/components/schemas/Region" }, "cla": { "type": "string" }, "warnings": { "type": "string" }, "payslipLines": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLine" } }, "payslipCertificateInsuranceInfoEntity": { "$ref": "#/components/schemas/PayslipCertificateInsuranceInfo" }, "holidays": { "type": "array", "items": { "$ref": "#/components/schemas/Holiday" } }, "status": { "type": "string", "enum": [ "DRAFT", "FINAL" ] }, "fromSwitzerland": { "type": "boolean" }, "regionAvailable": { "type": "boolean" } } }, "PayslipCertificateInsuranceInfo": { "type": "object", "properties": { "id": { "type": "integer" }, "salaryRent": { "type": "array", "items": { "type": "integer" } }, "ancillaryWageBenefitsPensionHousing": { "type": "array", "items": { "type": "integer" } }, "ancillaryWageBenefitsPrivateCarUse": { "type": "array", "items": { "type": "integer" } }, "ancillaryWageBenefitsOther": { "type": "array", "items": { "type": "integer" } }, "nonRecurringBenefits": { "type": "array", "items": { "type": "integer" } }, "capitalBenefits": { "type": "array", "items": { "type": "integer" } }, "participationFeeAccordingToAnnex": { "type": "array", "items": { "type": "integer" } }, "allowancesOfTheMembersOfTheAdministration": { "type": "array", "items": { "type": "integer" } }, "otherServices": { "type": "array", "items": { "type": "integer" } }, "socialContributions": { "type": "array", "items": { "type": "integer" } }, "occupationalBenefitsOrdinary": { "type": "array", "items": { "type": "integer" } }, "occupationalBenefitsRePurchaseContributions": { "type": "array", "items": { "type": "integer" } }, "directTaxAtSource": { "type": "array", "items": { "type": "integer" } }, "costAllowancesTravelFoodLodging": { "type": "array", "items": { "type": "integer" } }, "costAllowancesActualCosts": { "type": "array", "items": { "type": "integer" } }, "costAllowancesFixedExpensesRepresentation": { "type": "array", "items": { "type": "integer" } }, "costAllowancesFixedExpensesCar": { "type": "array", "items": { "type": "integer" } }, "costAllowancesFixedExpensesOther": { "type": "array", "items": { "type": "integer" } }, "developmentContributions": { "type": "array", "items": { "type": "integer" } }, "avsSalary": { "type": "array", "items": { "type": "integer" } }, "aciSalary": { "type": "array", "items": { "type": "integer" } }, "aciiSalary": { "type": "array", "items": { "type": "integer" } }, "laaSalary": { "type": "array", "items": { "type": "integer" } }, "laacSalary": { "type": "array", "items": { "type": "integer" } }, "laacExceesSalary": { "type": "array", "items": { "type": "integer" } }, "apgSalary": { "type": "array", "items": { "type": "integer" } } } }, "PayslipLine": { "required": [ "localizations", "number", "payslipLineSign", "payslipLineType" ], "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "localizations": { "$ref": "#/components/schemas/TranslationEntity" }, "payslipLineType": { "type": "string", "enum": [ "EMPLOYEE_LINE", "COMPANY_LINE", "BOTH", "CALCULATION", "SYSTEM" ] }, "payslipLineSign": { "type": "string", "enum": [ "INCOME", "CHARGES" ] }, "isShownOnSalarySlip": { "type": "boolean" }, "isAutomaticallyAdded": { "type": "boolean" }, "isLinkedToAccount": { "type": "boolean" }, "specialAttributionType": { "type": "string", "enum": [ "BASE_SALARY", "GROSS_SALARY", "NET_SALARY", "PAYABLE", "CHARGES", "EMPLOYEE_ALLOCATION", "SYSTEM_LINE_ADJUSTMENT" ] }, "payslipEntityId": { "type": "integer" }, "systemLine": { "oneOf": [ { "$ref": "#/components/schemas/SystemLine" }, { "$ref": "#/components/schemas/BothLine" }, { "$ref": "#/components/schemas/CalculationLine" }, { "$ref": "#/components/schemas/CompanyLine" }, { "$ref": "#/components/schemas/EmployeeLine" } ] }, "parentPayslipLines": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "touched": { "type": "boolean" }, "shouldIncludeVat": { "type": "boolean" }, "isHourlyWageLine": { "type": "boolean" }, "description": { "$ref": "#/components/schemas/Translation" }, "lineName": { "$ref": "#/components/schemas/Translation" } } }, "SystemLine": { "type": "object", "properties": { "id": { "type": "integer" }, "payslipLineType": { "type": "string", "enum": [ "EMPLOYEE_LINE", "COMPANY_LINE", "BOTH", "CALCULATION", "SYSTEM" ] }, "systemAdjustmentLineNumber": { "type": "integer" } }, "discriminator": { "propertyName": "payslipLineType" } }, "GenerateSalariesInfo": { "type": "object", "properties": { "calendarYear": { "type": "integer", "format": "int32" }, "monthType": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "monthStartDate": { "type": "string", "format": "date-time" }, "monthEndDate": { "type": "string", "format": "date-time" }, "date": { "type": "string" }, "employees": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PayrollEmployeeInfo" } } } }, "PayrollEmployeeInfo": { "type": "object", "properties": { "id": { "type": "integer" }, "staffId": { "type": "integer" }, "currencyId": { "type": "integer" }, "staffAccountId": { "type": "integer" }, "staffPayslipId": { "type": "integer" }, "organizationAccountId": { "type": "integer" }, "genderType": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "salaryType": { "type": "string", "enum": [ "MONTHLY", "HOURLY" ] }, "birthday": { "type": "string" }, "payableToBankId": { "type": "integer" }, "hourlySalaryType": { "type": "boolean" } } }, "Payroll": { "required": [ "createdOn", "paymentDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "createdOn": { "type": "string" }, "paymentDate": { "type": "string" }, "calendarYear": { "type": "integer", "format": "int32" }, "monthType": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "monthStartDate": { "type": "string", "format": "date-time" }, "monthEndDate": { "type": "string", "format": "date-time" }, "staffEntityId": { "type": "integer" }, "contactEntityId": { "type": "integer" }, "currencyId": { "type": "integer" }, "employeeInfoId": { "type": "integer" }, "address": { "$ref": "#/components/schemas/Address" }, "grossSalary": { "type": "string" }, "netSalary": { "type": "string" }, "payable": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "UNPAID", "PAID", "PARTIALLY_PAID", "WIRED" ] }, "warnings": { "type": "string" }, "isDeleted": { "type": "boolean" }, "payrollLines": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollLine" } }, "payrollPayments": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollPayment" } }, "journalEntryId": { "type": "integer" }, "staffPayslipId": { "type": "integer" }, "removedPayrollLineNumbers": { "type": "array", "items": { "type": "integer" } }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "isDocSent": { "type": "boolean", "readOnly": true } } }, "PayrollLine": { "type": "object", "properties": { "id": { "type": "integer" }, "payrollEntityId": { "type": "integer" }, "payslipLineEntityId": { "type": "integer" }, "number": { "type": "integer" }, "localizations": { "$ref": "#/components/schemas/TranslationEntity" }, "payslipValueType": { "type": "string", "enum": [ "VALUE", "PERCENTAGE" ] }, "isAutomaticallyAdded": { "type": "boolean" }, "payslipLineType": { "type": "string", "enum": [ "EMPLOYEE_LINE", "COMPANY_LINE", "BOTH", "CALCULATION", "SYSTEM" ] }, "description": { "type": "string" }, "baseAmount": { "type": "string" }, "employeeRate": { "type": "string" }, "employerRate": { "type": "string" }, "employeeAmount": { "type": "string" }, "employerAmount": { "type": "string" }, "specialAttributionType": { "type": "string", "enum": [ "BASE_SALARY", "GROSS_SALARY", "NET_SALARY", "PAYABLE", "CHARGES", "EMPLOYEE_ALLOCATION", "SYSTEM_LINE_ADJUSTMENT" ] }, "isChanged": { "type": "boolean" }, "isShownOnSalarySlip": { "type": "boolean" }, "orgEmployeeGroupId": { "type": "integer" } } }, "PayrollPayment": { "required": [ "payableByAccountId", "requestedDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "payrollEntityId": { "type": "integer" }, "requestedDate": { "type": "string" }, "plannedDate": { "type": "string" }, "sentDate": { "type": "string" }, "valueDate": { "type": "string" }, "requestedAmount": { "type": "string" }, "paidAmount": { "type": "string" }, "bankCharges": { "type": "string" }, "payableByAccountId": { "type": "integer" }, "payableToBankId": { "type": "integer" }, "isFromLockedAccountingPeriod": { "type": "boolean" } } }, "Payable": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "paymentId": { "type": "integer" }, "invoiceId": { "type": "integer" }, "invoiceDate": { "type": "string" }, "accountId": { "type": "integer" }, "requestedDate": { "type": "string" }, "plannedDate": { "type": "string" }, "sentDate": { "type": "string" }, "invoiceReference": { "type": "string" }, "payableAmount": { "type": "number" }, "warnings": { "type": "string" }, "contact": { "type": "string" }, "contactId": { "type": "integer" }, "currency": { "type": "string" }, "currencyId": { "type": "integer" }, "documentFileId": { "type": "integer" }, "fileExtension": { "type": "string" } } }, "PayableView": { "type": "object", "properties": { "organizationId": { "type": "integer" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "paymentId": { "type": "integer" }, "invoiceId": { "type": "integer" }, "invoiceDate": { "type": "string", "format": "date-time" }, "accountId": { "type": "integer" }, "requestedDate": { "type": "string", "format": "date-time" }, "plannedDate": { "type": "string", "format": "date-time" }, "minOfRequestedAndPlannedDate": { "type": "string", "format": "date-time" }, "sentDate": { "type": "string", "format": "date-time" }, "invoiceReference": { "type": "string" }, "payableAmount": { "type": "number" }, "comment": { "type": "string" }, "warnings": { "type": "string" }, "contact": { "type": "string" }, "contactId": { "type": "integer" }, "currency": { "type": "string" }, "currencyId": { "type": "integer" }, "documentFileId": { "type": "integer" }, "fileExtension": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "entityCreatorContactId": { "type": "integer" }, "paymentFileReference": { "type": "string" }, "workflowPermissions": { "type": "string" }, "tenantId": { "type": "integer" } } }, "Pain001GenerationRequest": { "type": "object", "properties": { "paymentsForGeneration": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentForGeneration" } }, "payableByChartOfAccountId": { "type": "integer" }, "plannedDate": { "type": "string" }, "feeSplit": { "type": "string", "enum": [ "CHARGED_TO_THE_BENEFICIARY", "FIFTY_FIFTY_SPLIT", "CHARGED_TO_THE_ORDERER" ] }, "timezone": { "type": "integer", "format": "int32" }, "isConfidential": { "type": "boolean" } } }, "PaymentForGeneration": { "type": "object", "properties": { "paymentId": { "type": "integer" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] } } }, "Language": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "isMain": { "type": "boolean" } } }, "NewOrganization": { "required": [ "currency", "fiscalYearEnd", "fiscalYearStart", "mainLanguage", "managingCompanyId", "name", "startDate", "templateCompanyBy", "vatRuleType" ], "type": "object", "properties": { "name": { "type": "string" }, "mainLanguage": { "$ref": "#/components/schemas/Language" }, "currency": { "type": "string" }, "templateCompanyBy": { "type": "string", "enum": [ "NOGA_CODE", "TEMPLATE_ORGANIZATION" ] }, "nogaCodeId": { "type": "integer" }, "templateOrganizationId": { "type": "integer" }, "startDate": { "type": "string" }, "address": { "$ref": "#/components/schemas/OrganizationAddress" }, "fiscalYearStart": { "type": "string" }, "fiscalYearEnd": { "type": "string" }, "vatRuleType": { "type": "string", "enum": [ "NONE", "AGREED_SERVICE", "RECEIVED_COMPENSATION", "NTDR_AGREED_SERVICE", "NTDR_RECEIVED_COMPENSATION", "FLAT_RATE_RECEIVED_COMPENSATION", "FLAT_RATE_AGREED_SERVICE", "SIMPLE_TAX_RATE" ] }, "timesheets": { "type": "boolean" }, "managingCompanyId": { "type": "integer" }, "id": { "type": "integer" } } }, "OrganizationAddress": { "required": [ "city", "countryCode2", "line1", "postCode" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "region": { "$ref": "#/components/schemas/Region" }, "countryCode2": { "type": "string" }, "postCode": { "type": "string" }, "toTheAttentionOf": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer" }, "houseNumber": { "type": "string" }, "service": { "type": "string" }, "dtbNumber": { "type": "string" }, "cedNumber": { "type": "string" }, "fiduciaryId": { "type": "integer" } } }, "GrantedAuthority": { "type": "object", "properties": { "authority": { "type": "string" } } }, "PermissionAuthority": { "type": "object", "properties": { "authority": { "type": "string" } } }, "WealUserDetails": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "permissionAuthorities": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PermissionAuthority" } }, "authorities": { "type": "array", "items": { "$ref": "#/components/schemas/GrantedAuthority" } }, "password": { "type": "string" }, "username": { "type": "string" }, "secret": { "type": "string" }, "parentContactId": { "type": "integer" }, "userDbId": { "type": "integer" }, "defaultLanguage": { "type": "string", "enum": [ "EN", "FR", "DE", "IT", "UNDEFINED" ] }, "organizationId": { "type": "integer" }, "organizationCountryId": { "type": "integer" }, "organizationCountryRegionId": { "type": "integer" }, "isAdmin": { "type": "boolean", "writeOnly": true }, "isMainUser": { "type": "boolean" }, "isImpersonateOthers": { "type": "boolean" }, "organizationMainLanguage": { "type": "string", "enum": [ "EN", "FR", "DE", "IT", "UNDEFINED" ] }, "authorizationToken": { "type": "string" }, "userGroupIds": { "type": "array", "items": { "type": "integer" } }, "isConsolidatedOrganization": { "type": "boolean" }, "subUserContactId": { "type": "integer" }, "enabled": { "type": "boolean" }, "active": { "type": "boolean" }, "notMainUser": { "type": "boolean" }, "notAdmin": { "type": "boolean" }, "contentLanguage": { "type": "string", "enum": [ "EN", "FR", "DE", "IT", "UNDEFINED" ] }, "notNullUserGroupIds": { "type": "array", "items": { "type": "integer" } }, "blockedForLicenceNonPayment": { "type": "boolean" }, "admin": { "type": "boolean" }, "accountNonExpired": { "type": "boolean" }, "accountNonLocked": { "type": "boolean" }, "credentialsNonExpired": { "type": "boolean" } } }, "DefaultCodesDetails": { "required": [ "annualProfitLoss", "bankExpenses", "clientBalanceSheet", "clientPL", "clientPrePayment", "clientUnrealizedFXProfitLoss", "clientVAT", "clientVATPaid", "compensation", "depreciationAccount", "extraordinaryExpenseAccount", "extraordinaryIncomeAccount", "lossOnDebtors", "retainedEarnings", "stock", "stockMovements", "supplierBalanceSheet", "supplierUnrealizedFXProfitLoss", "supplierVAT", "supplierVATPaid", "system", "transactionAdjustment", "unrealizedFxGainLossChart", "vatAccount" ], "type": "object", "properties": { "id": { "type": "integer" }, "clientBalanceSheet": { "type": "integer" }, "clientVAT": { "type": "integer" }, "clientVATPaid": { "type": "integer" }, "clientPrePayment": { "type": "integer" }, "clientPL": { "type": "integer" }, "supplierBalanceSheet": { "type": "integer" }, "supplierVAT": { "type": "integer" }, "supplierVATPaid": { "type": "integer" }, "supplierPrePayment": { "type": "integer" }, "retainedEarnings": { "type": "integer" }, "annualProfitLoss": { "type": "integer" }, "stock": { "type": "integer" }, "stockMovements": { "type": "integer" }, "bankExpenses": { "type": "integer" }, "transactionAdjustment": { "type": "integer" }, "accruedExpenses": { "type": "integer" }, "accruedRevenue": { "type": "integer" }, "compensation": { "type": "integer" }, "system": { "type": "integer" }, "lossOnDebtors": { "type": "integer" }, "workInProgress": { "type": "integer" }, "workInvoicedUpfront": { "type": "integer" }, "vatAccount": { "type": "integer" }, "depreciationAccount": { "type": "integer" }, "extraordinaryExpenseAccount": { "type": "integer" }, "extraordinaryIncomeAccount": { "type": "integer" }, "unrealizedFxGainLossChart": { "type": "integer" }, "clientUnrealizedFXProfitLoss": { "type": "integer" }, "supplierUnrealizedFXProfitLoss": { "type": "integer" }, "fXGainLoss": { "type": "integer" } } }, "Department": { "type": "object", "properties": { "id": { "type": "integer" }, "parentId": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } }, "isDeleted": { "type": "boolean" } } }, "Disbursement": { "type": "object", "properties": { "id": { "type": "integer" }, "upToAmount": { "type": "string" }, "disbursementFee": { "type": "string" } } }, "DocumentTemplate": { "type": "object", "properties": { "id": { "type": "integer" }, "logo": { "type": "integer" }, "report": { "type": "integer" }, "letterheadPortrait": { "type": "integer" }, "letterheadLandscape": { "type": "integer" }, "salesInvoicesTemplate": { "$ref": "#/components/schemas/PdfTemplate" }, "lateNoticesTemplate": { "$ref": "#/components/schemas/PdfTemplate" }, "payslipsTemplate": { "$ref": "#/components/schemas/PdfTemplate" }, "salesOrderTemplate": { "$ref": "#/components/schemas/PdfTemplate" }, "deliveryNoteTemplate": { "$ref": "#/components/schemas/PdfTemplate" } } }, "Ebics": { "required": [ "clientNumber", "userNumber" ], "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "ebicsServerId": { "type": "integer" }, "clientNumber": { "type": "string" }, "userNumber": { "type": "string" }, "status": { "type": "string" }, "orderTransmission": { "type": "boolean" }, "warnings": { "type": "string" }, "ebicsServerName": { "type": "string" }, "ebicsServerSwiftBic": { "type": "string" } } }, "EmployeeTask": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "rate": { "type": "number" }, "organizationId": { "type": "integer" }, "archived": { "type": "boolean" } } }, "InvoiceEmailContentSettings": { "type": "object", "properties": { "id": { "type": "integer" }, "salesInvoiceEmailSubjectLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "salesInvoiceEmailContentLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "customSalesInvoiceEmail": { "type": "boolean" }, "lateNoticesEmailSubjectLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "lateNoticesEmailContentLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "customLateNoticeEmail": { "type": "boolean" }, "orderEmailSubjectLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "orderEmailContentLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "customSalesOrderEmail": { "type": "boolean" } } }, "InvoiceSettings": { "required": [ "expenseAccountId" ], "type": "object", "properties": { "id": { "type": "integer" }, "defaultPaymentTerms": { "type": "string" }, "emailForInvoiceScans": { "type": "string" }, "scansTreatedByManagingOrg": { "type": "boolean" }, "validatePurchaseInvoicesByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "usePurchaseAccrualAccounting": { "type": "boolean" }, "skipDraftStatus": { "type": "boolean" }, "plannedPaymentDateOffset": { "type": "integer", "format": "int32" }, "purchasePaymentAccountId": { "type": "integer" }, "vatNumber": { "pattern": "^(CHE-\\d{3}\\.\\d{3}\\.\\d{3}.*)$|^$", "type": "string" }, "requestedPaymentTerms": { "type": "string" }, "numbering": { "type": "string" }, "timesheets": { "type": "boolean" }, "salesInvoiceConditionsLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "useSalesAccrualAccounting": { "type": "boolean" }, "validateSalesInvoicesByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "salesPaymentAccountId": { "type": "integer" }, "useUnsentSalesStatus": { "type": "boolean" }, "lateInvoiceRequestedPaymentTerms": { "type": "string" }, "lateInvoiceConditionsLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "orderIdNumbering": { "type": "string" }, "expenseAccountId": { "type": "integer" }, "orderValidity": { "type": "string" }, "validateOrdersByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "timesheetsAccountId": { "type": "integer" }, "disbursementAccountId": { "type": "integer" }, "salesOrderTermsLocalizations": { "$ref": "#/components/schemas/TranslationEntity" }, "useUnsentOrdersStatus": { "type": "boolean" }, "forceTreatedAsPi": { "type": "boolean" }, "invoiceEmailContentSettings": { "$ref": "#/components/schemas/InvoiceEmailContentSettings" }, "pdfInvoiceSplitterEnabled": { "type": "boolean" } } }, "MailServerConfig": { "required": [ "authType", "clientId", "fromEmail", "host", "oauthProvider", "port", "secureConnectionType" ], "type": "object", "properties": { "id": { "type": "integer" }, "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "secureConnectionType": { "type": "string", "enum": [ "TLS", "NONE" ] }, "userName": { "type": "string" }, "password": { "type": "string" }, "useAuth": { "type": "boolean" }, "fromEmail": { "type": "string" }, "authType": { "type": "string", "enum": [ "BASIC", "OAUTH2" ] }, "oauthProvider": { "type": "string", "enum": [ "GOOGLE", "MICROSOFT", "YAHOO" ] }, "clientId": { "type": "string" }, "oauthScopes": { "type": "string" }, "requiresReauth": { "type": "boolean" }, "oauth": { "type": "boolean" }, "basicAuth": { "type": "boolean" } } }, "OrganizationEmployeeGroup": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "payslipLineIds": { "type": "array", "items": { "type": "integer" } } } }, "OrganizationOfficePayslip": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationOfficeId": { "type": "integer" }, "compensationFundNumber": { "pattern": "^[0-9]{3}.[0-9]{1,3}$", "type": "string" }, "compensationFundAffiliatedNumber": { "type": "string" }, "compensationFundId": { "type": "integer" }, "childSupportAgencyId": { "type": "integer" }, "childSupportAgencyNumber": { "type": "string" }, "childSupportAgencyAffiliatedNumber": { "type": "string" } } }, "OrganizationPayslip": { "type": "object", "properties": { "id": { "type": "integer" }, "calendarYear": { "type": "integer", "format": "int32" }, "claPayslipId": { "type": "integer" }, "organizationPayslipLines": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationPayslipLine" } }, "salaryTableLines": { "type": "array", "items": { "$ref": "#/components/schemas/SalaryTableLine" } }, "holidays": { "type": "array", "items": { "$ref": "#/components/schemas/Holiday" } }, "organizationOfficePayslips": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationOfficePayslip" } }, "touched": { "type": "boolean" } } }, "OrganizationPayslipLine": { "required": [ "payslipLineEntityId" ], "type": "object", "properties": { "id": { "type": "integer" }, "payslipLineEntityId": { "type": "integer" }, "employeePercentage": { "type": "string" }, "employerPercentage": { "type": "string" }, "lowerLimit": { "type": "string" }, "upperLimit": { "type": "string" }, "limitCalculationType": { "type": "string", "enum": [ "TOTAL", "OVER_THE_LOWER_LIMIT" ] }, "genderType": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "insurerId": { "type": "integer" }, "code": { "type": "string" }, "insurerNumber": { "type": "string" }, "clientNumber": { "type": "string" }, "contractNumber": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" } } }, "OrganizationTemplate": { "required": [ "name", "organizationId" ], "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "documentTemplate": { "$ref": "#/components/schemas/DocumentTemplate" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" } } }, "SalaryCode": { "type": "object", "properties": { "id": { "type": "integer" }, "calendarYear": { "type": "integer", "format": "int32" }, "salaryCodeLines": { "type": "array", "items": { "$ref": "#/components/schemas/SalaryCodeLine" } } } }, "SalaryCodeLine": { "type": "object", "properties": { "id": { "type": "integer" }, "payslipLineEntityId": { "type": "integer" }, "salaryCodeId": { "type": "integer" }, "number": { "type": "integer" }, "localizations": { "$ref": "#/components/schemas/Translation" }, "payslipLineType": { "type": "string", "enum": [ "EMPLOYEE_LINE", "COMPANY_LINE", "BOTH", "CALCULATION", "SYSTEM" ] }, "specialAttributionType": { "type": "string", "enum": [ "BASE_SALARY", "GROSS_SALARY", "NET_SALARY", "PAYABLE", "CHARGES", "EMPLOYEE_ALLOCATION", "SYSTEM_LINE_ADJUSTMENT" ] }, "isLinkedToAccount": { "type": "boolean" }, "payslipValueSplitType": { "type": "string", "enum": [ "EMPLOYEE", "EMPLOYER", "BOTH" ] }, "balanceSheetAccountId": { "type": "integer" }, "plOperationsAccountId": { "type": "integer" }, "plAdminsAccountId": { "type": "integer" } } }, "SalaryTableLine": { "type": "object", "properties": { "id": { "type": "integer" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "payslipEntityId": { "type": "integer" }, "payslipLineId": { "type": "string" }, "organizationPayslipEntityId": { "type": "integer" }, "staffPayslipEntityId": { "type": "integer" }, "number": { "type": "integer" }, "description": { "type": "string" }, "employeeValue": { "type": "string" }, "employerValue": { "type": "string" }, "quantity": { "type": "string" }, "employeePercentage": { "type": "string" }, "employerPercentage": { "type": "string" }, "organizationEmployeeGroupId": { "type": "integer" } } }, "StandaloneOrganizationDetails": { "required": [ "currency", "mainLanguage", "name", "startDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "officeAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationAddress" } }, "currency": { "type": "string" }, "banks": { "type": "array", "items": { "$ref": "#/components/schemas/Bank" } }, "mainLanguage": { "$ref": "#/components/schemas/Language" }, "otherLanguages": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "parentStandaloneOrganizationId": { "type": "integer" }, "managingStandaloneOrganizationId": { "type": "integer", "format": "int32" }, "managingStandaloneOrganizationName": { "type": "string" }, "canModifyManagingOrganization": { "type": "boolean" }, "managingChildrenOrganizationIds": { "type": "array", "items": { "type": "integer" } }, "invoiceSettings": { "$ref": "#/components/schemas/InvoiceSettings" }, "nogaCodeId": { "type": "integer" }, "warnings": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "defaultCodes": { "$ref": "#/components/schemas/DefaultCodesDetails" }, "disbursements": { "type": "array", "items": { "$ref": "#/components/schemas/Disbursement" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeTask" } }, "organizationPayslips": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationPayslip" } }, "stockStrategy": { "type": "string", "enum": [ "FIFO", "LIFO", "AVERAGE", "UNIT", "TRADING" ] }, "departments": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } }, "externalId": { "type": "string" }, "salaryCodes": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/SalaryCode" } }, "contactId": { "type": "integer" }, "archived": { "type": "boolean" }, "isFreeTier": { "type": "boolean" }, "mailServerConfig": { "$ref": "#/components/schemas/MailServerConfig" }, "employeeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationEmployeeGroup" } }, "payslipLineCodes": { "type": "array", "items": { "type": "string" } }, "vatSupplierContactId": { "type": "integer" }, "useUnsentPayrollStatus": { "type": "boolean" }, "automaticSynchronizationOfContacts": { "type": "boolean" }, "uid": { "type": "string" }, "ebics": { "type": "array", "items": { "$ref": "#/components/schemas/Ebics" } }, "unusedVacationsSettings": { "$ref": "#/components/schemas/UnusedVacationsSettings" }, "isConsolidated": { "type": "boolean" }, "consolidatedOrganizationIds": { "type": "array", "items": { "type": "integer" } }, "organizationTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationTemplate" } }, "auditorId": { "type": "integer" }, "isFiduciary": { "type": "boolean" }, "validateSalesInvoicesByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "validateOrdersByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "validatePurchaseInvoicesByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] } } }, "UnusedVacationsSettings": { "required": [ "adminBalanceSheetAccountId", "adminPlAccountId", "operationsBalanceSheetAccountId", "operationsPlAccountId" ], "type": "object", "properties": { "id": { "type": "integer" }, "autoProvisionUnusedVacations": { "type": "boolean" }, "adminBalanceSheetAccountId": { "type": "integer" }, "adminPlAccountId": { "type": "integer" }, "operationsBalanceSheetAccountId": { "type": "integer" }, "operationsPlAccountId": { "type": "integer" } } }, "Order": { "required": [ "contactId", "currencyId", "name", "periodicityConfiguration" ], "type": "object", "properties": { "id": { "type": "integer" }, "contactId": { "type": "integer" }, "contactName": { "type": "string" }, "orderId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "statusLastChangedDate": { "type": "string" }, "description": { "type": "string" }, "parentOrderId": { "type": "integer" }, "department": { "type": "integer" }, "vatRateId": { "type": "integer" }, "currencyId": { "type": "integer" }, "requestedPaymentTerms": { "type": "string" }, "orderValidity": { "type": "string" }, "minimumAmountToInvoice": { "type": "string" }, "ourContactId": { "type": "integer" }, "yourContactId": { "type": "integer" }, "periodicityConfiguration": { "$ref": "#/components/schemas/OrderPeriodicity" }, "isTimesheetsEnabled": { "type": "boolean" }, "timesheetsAccountId": { "type": "integer" }, "fixedAmount": { "type": "string" }, "timesheetsVatRateId": { "type": "integer" }, "timesheetsVat": { "type": "string" }, "timesheetsTotalPrice": { "type": "string" }, "timesheetsDescription": { "type": "string" }, "timesheetsLongDescription": { "type": "string" }, "timesheetsDiscount": { "maximum": 99.99, "exclusiveMaximum": false, "minimum": 0.0, "exclusiveMinimum": false, "type": "number" }, "timesheetsDepartmentId": { "type": "integer" }, "timesheetsOfficeId": { "type": "integer" }, "isExpensesEnabled": { "type": "boolean" }, "isDisbursementFeeEnabled": { "type": "boolean" }, "disbursementDepartmentId": { "type": "integer" }, "expensesDepartmentId": { "type": "integer" }, "office": { "type": "integer" }, "disbursementOfficeId": { "type": "integer" }, "expensesOfficeId": { "type": "integer" }, "includedArticles": { "type": "array", "items": { "$ref": "#/components/schemas/OrderArticle" } }, "orderLines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" } }, "orderElementsLayoutLines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderElementsLayoutLine" } }, "warnings": { "type": "string" }, "organizationId": { "type": "integer" }, "isInvoiceGenerated": { "type": "boolean" }, "hasOnlyPrepaymentsInvoices": { "type": "boolean" }, "yourReference": { "type": "string" }, "clientAddressId": { "type": "integer" }, "address": { "$ref": "#/components/schemas/Address" }, "clientName": { "type": "string" }, "statusHistories": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusHistory" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTask" } }, "clientHasVatType": { "type": "boolean" }, "validated": { "type": "boolean" }, "paymentAccountId": { "type": "integer" }, "validatorUserIdsSize": { "type": "integer" }, "validatorUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "realValidated": { "type": "boolean" }, "activeSubOrderId": { "type": "integer" }, "activeSubOrderInvoicingDate": { "type": "string", "format": "date-time" }, "systemValidated": { "type": "boolean" }, "hasProformaInvoice": { "type": "boolean" }, "periodic": { "type": "boolean" } } }, "OrderArticle": { "required": [ "articleId" ], "type": "object", "properties": { "id": { "type": "integer" }, "tempId": { "type": "integer" }, "orderId": { "type": "integer" }, "articleId": { "type": "integer" }, "description": { "type": "string" }, "longDescription": { "type": "string" }, "price": { "type": "string" }, "amount": { "type": "string" }, "discount": { "type": "string" }, "totalNet": { "type": "string" }, "vatRateId": { "type": "integer" }, "vat": { "type": "string" }, "totalPrice": { "type": "string" }, "status": { "type": "string", "enum": [ "SHIPPED", "PARTIALLY_SHIPPED", "NOT_SHIPPED", "SERVICE" ] }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderShipment" } }, "articleName": { "$ref": "#/components/schemas/Translation" }, "articleMeasurement": { "type": "string", "readOnly": true, "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "departmentId": { "type": "integer" }, "officeId": { "type": "integer" } } }, "OrderElementsLayoutLine": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" }, "position": { "type": "integer", "format": "int32" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/OrderElementsLayoutLine" } }, "lineType": { "type": "string", "enum": [ "ARTICLE", "ORDER_LINE", "TIMESHEET", "TIMESHEET_FIXED", "EXPENSES", "DISBURSEMENT", "HEADER" ] }, "orderElementId": { "type": "integer" } } }, "OrderLine": { "type": "object", "properties": { "id": { "type": "integer" }, "tempId": { "type": "integer" }, "orderId": { "type": "integer" }, "description": { "type": "string" }, "longDescription": { "type": "string" }, "saleAccountId": { "type": "integer" }, "price": { "type": "string" }, "amount": { "type": "string" }, "discount": { "type": "string" }, "totalNet": { "type": "string" }, "vatRateId": { "type": "integer" }, "vat": { "type": "string" }, "totalPrice": { "type": "string" }, "saleAccountName": { "$ref": "#/components/schemas/Translation" }, "departmentId": { "type": "integer" }, "officeId": { "type": "integer" } } }, "OrderPeriodicity": { "required": [ "startDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "periodicityType": { "type": "string", "enum": [ "NONE", "DAILY", "WEEKLY", "BI_WEEKLY", "EVERY_MONTH", "EVERY_2_MONTH", "EVERY_3_MONTH", "EVERY_4_MONTH", "EVERY_6_MONTH", "ANNUAL" ] }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "invoicingTime": { "type": "string", "enum": [ "FIRST_DAY", "LAST_DAY", "FIRST_WORKING_DAY", "LAST_WORKING_DAY" ] }, "orderId": { "type": "integer" } } }, "OrderStatusHistory": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "date": { "type": "string" } } }, "OrderTask": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "rate": { "type": "number" }, "parentId": { "type": "integer" }, "position": { "type": "integer", "format": "int32" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTask" } }, "archived": { "type": "boolean" } } }, "PrePayment": { "required": [ "date", "description" ], "type": "object", "properties": { "netAmount": { "type": "string" }, "date": { "type": "string" }, "description": { "type": "string" }, "longDescription": { "type": "string" } } }, "PartialPayment": { "required": [ "date" ], "type": "object", "properties": { "date": { "type": "string" }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/PartialPaymentArticle" } }, "orderLines": { "type": "array", "items": { "$ref": "#/components/schemas/PartialPaymentOrderLine" } } } }, "PartialPaymentArticle": { "type": "object", "properties": { "orderArticleId": { "type": "integer" }, "amount": { "type": "string" }, "totalNet": { "type": "string" } } }, "PartialPaymentOrderLine": { "type": "object", "properties": { "orderLineId": { "type": "integer" }, "amount": { "type": "string" }, "totalNet": { "type": "string" } } }, "ChangePasswordMyAccount": { "type": "object", "properties": { "id": { "type": "integer" }, "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "TimeEntry": { "required": [ "date", "orderId" ], "type": "object", "properties": { "description": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "REJECTED", "APPROVED", "BILLED" ] }, "isBillable": { "type": "boolean" }, "id": { "type": "integer" }, "date": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "time": { "pattern": "^(\\d+[.]\\d{2})|$", "type": "string" }, "clientId": { "type": "integer" }, "clientName": { "type": "string" }, "orderId": { "type": "integer" }, "orderName": { "type": "string" }, "taskId": { "type": "integer" }, "taskName": { "type": "string" }, "isLocked": { "type": "boolean" } } }, "Expense": { "required": [ "chartOfAccountsId", "currencyId", "date", "merchant", "paymentType" ], "type": "object", "properties": { "id": { "type": "integer" }, "reBill": { "type": "boolean" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "APPROVED", "REFUSED", "BILLED" ] }, "description": { "type": "string" }, "isEditable": { "type": "boolean" }, "date": { "type": "string" }, "merchant": { "type": "string" }, "currencyNetAmount": { "type": "string" }, "currencyVatAmount": { "type": "string" }, "currencyTotalAmount": { "type": "string" }, "companyCurrencyTotalAmount": { "type": "string" }, "paymentType": { "type": "string", "enum": [ "OWN_RESOURCES", "COMPANY_RESOURCES" ] }, "currencyId": { "type": "integer" }, "chartOfAccountsId": { "type": "integer" }, "departmentId": { "type": "integer" }, "orderId": { "type": "integer" }, "orderClientId": { "type": "integer" }, "vatRateId": { "type": "integer" }, "receiptDocumentFileId": { "type": "integer" }, "receiptDocumentFileExtension": { "type": "string" }, "officeId": { "type": "integer" } } }, "ConnectResponse": { "type": "object", "properties": { "isSuccessful": { "type": "boolean" }, "errorType": { "type": "string", "enum": [ "VALIDATION_ERROR", "SERVER_UNREACHABLE", "AUTHENTICATION_FAILED", "OTHER" ] }, "message": { "type": "string" } } }, "OAuthInitRequest": { "required": [ "clientId", "clientSecret", "mailServerConfigId", "provider", "redirectUri" ], "type": "object", "properties": { "mailServerConfigId": { "type": "integer" }, "provider": { "type": "string", "enum": [ "GOOGLE", "MICROSOFT", "YAHOO" ] }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "redirectUri": { "type": "string" } } }, "OAuthConsentUrlResponse": { "type": "object", "properties": { "consentUrl": { "type": "string" }, "state": { "type": "string" } } }, "OAuthCallbackRequest": { "required": [ "code", "mailServerConfigId", "redirectUri", "state" ], "type": "object", "properties": { "mailServerConfigId": { "type": "integer" }, "code": { "type": "string" }, "state": { "type": "string" }, "redirectUri": { "type": "string" } } }, "JournalImportFileDto": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "JournalEntry": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "entryId": { "type": "integer" }, "entryDate": { "type": "string" }, "description": { "type": "string" }, "amount": { "type": "number" }, "journalLines": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLine" } }, "type": { "type": "string", "enum": [ "OPENING", "MANUAL", "PURCHASE_INVOICE", "SALES_INVOICE", "SALARY_SLIP", "STOCK", "CLOSING", "SYSTEM", "SYSTEM_FX", "SYSTEM_PFUV", "FIXED_ASSET" ] }, "warnings": { "type": "string" }, "isUnmodifiable": { "type": "boolean" } } }, "JournalLine": { "required": [ "accountId" ], "type": "object", "properties": { "id": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "accountId": { "type": "integer" }, "accountNumber": { "type": "integer" }, "description": { "$ref": "#/components/schemas/Translation" }, "accountCurrencyId": { "type": "integer" }, "accountCurrencyCode": { "type": "string" }, "foreignCurrencyId": { "type": "integer" }, "foreignCurrencyCode": { "type": "string" }, "accountDebit": { "type": "string" }, "accountCredit": { "type": "string" }, "foreignDebit": { "type": "string" }, "foreignCredit": { "type": "string" }, "companyDebit": { "type": "string" }, "companyCredit": { "type": "string" }, "departmentId": { "type": "integer" }, "departmentName": { "type": "string" }, "contactId": { "type": "integer" }, "contactName": { "type": "string" }, "orderId": { "type": "integer" }, "orderIdToDisplay": { "type": "string" }, "articleId": { "type": "integer" }, "articleIdToDisplay": { "$ref": "#/components/schemas/Translation" }, "vatCodes": { "type": "array", "items": { "$ref": "#/components/schemas/VatCode" } }, "vatCodesConcatenated": { "$ref": "#/components/schemas/Translation" }, "accountName": { "$ref": "#/components/schemas/Translation" }, "officeId": { "type": "integer" }, "officeName": { "type": "string" } } }, "VatCode": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "title": { "$ref": "#/components/schemas/Translation" }, "countryId": { "type": "integer" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "effectiveDate": { "type": "string" } } }, "ExpenseDraft": { "required": [ "date" ], "type": "object", "properties": { "id": { "type": "integer" }, "reBill": { "type": "boolean" }, "description": { "type": "string" }, "date": { "type": "string" }, "merchant": { "type": "string" }, "currencyNetAmount": { "type": "string" }, "currencyVatAmount": { "type": "string" }, "currencyTotalAmount": { "type": "string" }, "companyCurrencyTotalAmount": { "type": "string" }, "paymentType": { "type": "string", "enum": [ "OWN_RESOURCES", "COMPANY_RESOURCES" ] }, "currencyId": { "type": "integer" }, "chartOfAccountsId": { "type": "integer" }, "departmentId": { "type": "integer" }, "orderId": { "type": "integer" }, "orderClientId": { "type": "integer" }, "vatRateId": { "type": "integer" }, "receiptDocumentFileId": { "type": "integer" }, "receiptDocumentFileExtension": { "type": "string" }, "officeId": { "type": "integer" } } }, "CurrencyConversion": { "type": "object", "properties": { "currencyFrom": { "type": "integer" }, "currencyTo": { "type": "integer" }, "date": { "type": "string" }, "requestedAmount": { "type": "number" }, "convertedAmount": { "type": "number" } } }, "MainUser": { "type": "object", "properties": { "isMainUser": { "type": "boolean" }, "id": { "type": "integer" } } }, "ChangePasswordForContact": { "type": "object", "properties": { "id": { "type": "integer" }, "newPassword": { "type": "string" } } }, "MergeClientRequest": { "type": "object", "properties": { "targetId": { "type": "integer" }, "sourceId": { "type": "integer" } } }, "AdditionalInformation": { "type": "object", "properties": { "id": { "type": "integer" }, "note": { "type": "string" }, "tag": { "$ref": "#/components/schemas/ContactTagEntity" } } }, "ArticleDiscount": { "required": [ "articleId", "discount" ], "type": "object", "properties": { "id": { "type": "integer" }, "articleId": { "type": "integer" }, "discount": { "type": "number" }, "articleIdName": { "$ref": "#/components/schemas/Translation" } } }, "BillableRate": { "required": [ "startDate" ], "type": "object", "properties": { "id": { "type": "integer" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "orderId": { "type": "integer" }, "task": { "$ref": "#/components/schemas/EmployeeTask" }, "rate": { "type": "string" }, "clientId": { "type": "integer" }, "staffId": { "type": "integer" }, "clientName": { "type": "string" } } }, "Client": { "type": "object", "properties": { "id": { "type": "integer" }, "businessUnitId": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "balanceSheetAccountId": { "type": "integer" }, "currencyId": { "type": "integer" }, "orderAddressId": { "type": "integer" }, "orderAddressName": { "type": "string" }, "invoiceAddressId": { "type": "integer" }, "invoiceAddressName": { "type": "string" }, "paymentTerms": { "type": "string" }, "lateNoticeMargin": { "type": "string" }, "clientDiscountRate": { "type": "string" }, "creditLimit": { "type": "string" }, "contactId": { "type": "integer" }, "vatNumber": { "type": "string" }, "advancedInvoicingNote": { "type": "string" }, "vatTypeCodeId": { "type": "integer" }, "vatRateId": { "type": "integer" }, "orderValidity": { "type": "string" }, "articleDiscounts": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleDiscount" } }, "businessUnitName": { "type": "string" }, "paymentAccountName": { "$ref": "#/components/schemas/Translation" }, "PLAccountName": { "$ref": "#/components/schemas/Translation" }, "balanceSheetAccountName": { "$ref": "#/components/schemas/Translation" }, "billingEmail": { "type": "string" }, "orderEmail": { "type": "string" }, "lateNoticeEmail": { "type": "string" }, "officeId": { "type": "integer" }, "placcountId": { "type": "integer" }, "placcountName": { "$ref": "#/components/schemas/Translation" } } }, "Communication": { "required": [ "date" ], "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string" }, "type": { "type": "string", "enum": [ "PHONE_CALL", "EMAIL", "INTERNAL_MEETING", "EXTERNAL_MEETING", "NOTE" ] }, "description": { "type": "string" }, "longDescription": { "type": "string" }, "ourContactId": { "type": "integer" }, "externalContactId": { "type": "integer" }, "externalContactName": { "type": "string" }, "ourContactName": { "type": "string" }, "externalContactIdName": { "type": "string" } } }, "Contact": { "type": "object", "properties": { "contactId": { "type": "integer" }, "contactType": { "type": "string", "enum": [ "ORGANIZATION", "PERSON" ] }, "isCustomer": { "type": "boolean" }, "isVendor": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "isUser": { "type": "boolean" }, "defaultLanguage": { "type": "string", "enum": [ "EN", "FR", "DE", "IT", "UNDEFINED" ] }, "phone": { "type": "string" }, "fax": { "type": "string" }, "mobile": { "type": "string" }, "email": { "type": "string" }, "webSite": { "type": "string" }, "warnings": { "type": "string" }, "archived": { "type": "boolean" }, "relatedOrganizationContactIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "relatedContactIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "communications": { "type": "array", "items": { "$ref": "#/components/schemas/Communication" } }, "additionalInformation": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalInformation" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/IndividualTagEntity" } }, "banks": { "type": "array", "items": { "$ref": "#/components/schemas/Bank" } }, "organizationId": { "type": "integer" }, "organizationUsesTimesheets": { "type": "boolean" }, "permissionsTree": { "type": "array", "items": { "$ref": "#/components/schemas/ContactOrganizationAccess" } }, "defaultModule": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "supplier": { "$ref": "#/components/schemas/Supplier" }, "client": { "$ref": "#/components/schemas/Client" }, "staff": { "$ref": "#/components/schemas/Staff" }, "externalId": { "type": "string" }, "groupRoles": { "type": "array", "items": { "$ref": "#/components/schemas/BriefRole" } }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "id": { "type": "integer" }, "ecorrespondence": { "type": "boolean" } }, "discriminator": { "propertyName": "contactType" } }, "ContactOrganizationAccess": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "parentOrganizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/TreeRole" } }, "globalRoles": { "type": "array", "items": { "$ref": "#/components/schemas/TreeRole" } }, "availableRoles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleView" } }, "subUserContactId": { "type": "integer" }, "availableEmployees": { "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } } } }, "ContactTagEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "EmployeeGroup": { "type": "object", "properties": { "id": { "type": "integer" }, "staffPayslipEntityId": { "type": "integer" }, "groupType": { "type": "string", "enum": [ "ADMIN", "OPERATIONS" ] }, "departmentId": { "type": "integer" }, "percentage": { "type": "string" }, "departmentName": { "type": "string" }, "officeId": { "type": "integer" }, "officeName": { "type": "string" } } }, "FamilyMember": { "required": [ "birthDate", "familyMemberType" ], "type": "object", "properties": { "id": { "type": "integer" }, "staffId": { "type": "integer" }, "familyMemberType": { "type": "string", "enum": [ "SPOUSE", "CHILD" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthDate": { "type": "string" }, "nationalityCountryId": { "type": "integer" } } }, "IndividualTagEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "OrganizationContact": { "required": [ "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Contact" }, { "type": "object", "properties": { "name": { "type": "string" }, "nogaCodeId": { "type": "integer" }, "uid": { "type": "string" } } } ] }, "PersonContact": { "required": [ "firstName", "lastName" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Contact" }, { "type": "object", "properties": { "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "nationalityCountryId": { "type": "integer" }, "birthday": { "type": "string" }, "gender": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "isImpersonateOthers": { "type": "boolean" }, "isAdmin": { "type": "boolean" }, "isMainUser": { "type": "boolean" }, "isEmployee": { "type": "boolean" }, "avatarId": { "type": "integer" }, "isActive": { "type": "boolean" }, "isBlockedForLicenceNonPayment": { "type": "boolean" }, "loginEmail": { "type": "string" } } } ] }, "RoleView": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ROLE", "SUPER_ROLE" ] }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "integer" }, "realId": { "type": "integer" }, "roleType": { "type": "string", "enum": [ "ORGANIZATION", "GLOBAL" ] } } }, "SalaryInfo": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "staffId": { "type": "integer" }, "staffPayslipEntityId": { "type": "integer" }, "salaryType": { "type": "string", "enum": [ "MONTHLY", "HOURLY" ] }, "workOccupancy": { "type": "string" }, "numberOfVacationDays": { "type": "string" }, "defaultPaymentAccountId": { "type": "integer" }, "payrollCurrencyId": { "type": "integer" }, "isSourceTaxEnabled": { "type": "boolean" }, "capacity": { "type": "string" }, "hourlyRate": { "type": "string" }, "payableToBankId": { "type": "integer" }, "organizationEmployeeGroupId": { "type": "integer" }, "sourceTaxCode": { "type": "string" }, "regionId": { "type": "integer" }, "totalOccupancy": { "type": "string" }, "defaultPaymentAccountName": { "$ref": "#/components/schemas/Translation" }, "hasOnlyOneJob": { "type": "boolean" }, "singleParentType": { "type": "string", "enum": [ "NOCOHAB", "COHABSC", "COHABJC", "COHABO18" ] }, "denominationType": { "type": "string", "enum": [ "RCC", "CCC", "ERC", "IRC", "ONO" ] } } }, "Staff": { "type": "object", "properties": { "id": { "type": "integer" }, "avsNumber": { "type": "string" }, "permitExpiryDate": { "type": "string" }, "jobTitle": { "type": "string" }, "employmentStartDate": { "type": "string" }, "employmentEndDate": { "type": "string" }, "contactId": { "type": "integer" }, "workPermit": { "$ref": "#/components/schemas/WorkPermit" }, "contractType": { "type": "string", "enum": [ "OPEN_ENDED", "OPEN_ENDED_YEAR", "FIXED", "APPRENTICESHIP", "INTERN" ] }, "employeeDocumentType": { "type": "string", "enum": [ "PASSPORT", "ID" ] }, "documentNumber": { "type": "string" }, "documentExpiryDate": { "type": "string" }, "maritalType": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "SEPARATED", "WIDOWED" ] }, "maritalDate": { "type": "string" }, "isSpouseWorking": { "type": "boolean" }, "enforceTimesheets": { "type": "boolean" }, "familyMembers": { "type": "array", "items": { "$ref": "#/components/schemas/FamilyMember" } }, "timesheetPricingLines": { "type": "array", "items": { "$ref": "#/components/schemas/BillableRate" } }, "staffPayslips": { "type": "array", "items": { "$ref": "#/components/schemas/StaffPayslip" } }, "costCalculationType": { "type": "string", "enum": [ "AUTOMATIC", "MANUAL" ] }, "timesheetsCost": { "type": "string" }, "pdfPassword": { "type": "string" }, "trainingLevel": { "type": "string", "enum": [ "PHD", "MASTER_ETH", "BACHELOR_ETH", "MASTER_UAS", "BACHELOR_UAS", "HES", "MASTER", "BACHELOR", "TC", "MATU", "CVT", "IN_HOUSE", "COMP_SCHOOL" ] }, "position": { "type": "string", "enum": [ "SENIOR", "MIDDLE", "LOWER", "RESP" ] } } }, "StaffPayslip": { "type": "object", "properties": { "id": { "type": "integer" }, "staffId": { "type": "integer" }, "calendarYear": { "type": "integer", "format": "int32" }, "employmentStartDate": { "type": "string" }, "employmentEndDate": { "type": "string" }, "salaryCertificateNotes": { "type": "string" }, "isFreeTransportToWork": { "type": "boolean" }, "isCanteenMealsOrMealsVouchers": { "type": "boolean" }, "salaryInfo": { "$ref": "#/components/schemas/SalaryInfo" }, "employeeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeGroup" } }, "systemLine": { "$ref": "#/components/schemas/StaffPayslipSystemLine" }, "baseSalaryLine": { "$ref": "#/components/schemas/StaffPayslipBaseSalaryLine" }, "payslipTableLines": { "type": "array", "items": { "$ref": "#/components/schemas/SalaryTableLine" } } } }, "StaffPayslipBaseSalaryLine": { "type": "object", "properties": { "id": { "type": "integer" }, "staffPayslipEntityId": { "type": "integer" }, "payslipLineEntityId": { "type": "integer" }, "employeeAmount": { "type": "string" }, "employerAmount": { "type": "string" }, "payslipValueSplitType": { "type": "string", "enum": [ "EMPLOYEE", "EMPLOYER", "BOTH" ] } } }, "StaffPayslipSystemLine": { "type": "object", "properties": { "id": { "type": "integer" }, "staffPayslipEntityId": { "type": "integer" }, "payslipLineEntityId": { "type": "integer" }, "bracket": { "type": "string" }, "rate": { "type": "string" }, "localizations": { "$ref": "#/components/schemas/TranslationEntity" }, "number": { "type": "integer" } } }, "Supplier": { "type": "object", "properties": { "id": { "type": "integer" }, "businessUnitId": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "balanceSheetAccountId": { "type": "integer" }, "currencyId": { "type": "integer" }, "paymentTerms": { "type": "string" }, "feeSplitType": { "type": "string", "enum": [ "CHARGED_TO_THE_BENEFICIARY", "FIFTY_FIFTY_SPLIT", "CHARGED_TO_THE_ORDERER" ] }, "contactId": { "type": "integer" }, "vatNumber": { "type": "string" }, "vatType": { "type": "string", "enum": [ "NO_VAT", "NATIVE", "IMPORT_OF_SERVICE" ] }, "vatTypeCodeId": { "type": "integer" }, "vatRateId": { "type": "integer" }, "businessUnitName": { "type": "string" }, "paymentAccountName": { "$ref": "#/components/schemas/Translation" }, "PLAccountName": { "$ref": "#/components/schemas/Translation" }, "balanceSheetAccountName": { "$ref": "#/components/schemas/Translation" }, "officeId": { "type": "integer" }, "placcountId": { "type": "integer" }, "placcountName": { "$ref": "#/components/schemas/Translation" } } }, "TreeRole": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "ROLE", "SUPER_ROLE" ] }, "name": { "type": "string" }, "isDefault": { "type": "boolean" } } }, "WorkPermit": { "type": "object", "properties": { "id": { "type": "integer" }, "countryId": { "type": "integer" }, "name": { "$ref": "#/components/schemas/Translation" }, "nameId": { "type": "integer" } } }, "NewConsolidatedOrganization": { "required": [ "currency", "fiscalYearEnd", "fiscalYearStart", "mainLanguage", "managingCompanyId", "name", "organizationIds" ], "type": "object", "properties": { "name": { "type": "string" }, "mainLanguage": { "$ref": "#/components/schemas/Language" }, "currency": { "type": "string" }, "fiscalYearStart": { "type": "string" }, "fiscalYearEnd": { "type": "string" }, "organizationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "managingCompanyId": { "type": "integer" }, "id": { "type": "integer" } } }, "BudgetImportFileDto": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "id": { "type": "integer" }, "parent": { "type": "integer" }, "periodId": { "type": "integer" }, "name": { "type": "string" }, "reportType": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "CASH_FLOW", "RATIOS" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "department": { "type": "integer" }, "article": { "type": "integer" }, "contact": { "type": "integer" }, "orderId": { "type": "integer" }, "officeId": { "type": "integer" } } }, "BrowserInfo": { "required": [ "browserAcceptHeader", "browserColorDepth", "browserJavaEnabled", "browserLanguage", "browserScreenHeight", "browserScreenWidth", "browserTimeZone", "browserUserAgent" ], "type": "object", "properties": { "browserAcceptHeader": { "type": "string" }, "browserColorDepth": { "type": "string" }, "browserJavaEnabled": { "type": "string" }, "browserLanguage": { "type": "string" }, "browserScreenHeight": { "type": "string" }, "browserScreenWidth": { "type": "string" }, "browserTimeZone": { "type": "string" }, "browserUserAgent": { "type": "string" } } }, "CardInfo": { "required": [ "cardNumber", "cardholderName", "cvv", "expiryMonth", "expiryYear" ], "type": "object", "properties": { "cardNumber": { "type": "integer" }, "cardholderName": { "type": "string" }, "cvv": { "type": "string" }, "expiryMonth": { "type": "integer", "format": "int32" }, "expiryYear": { "type": "integer", "format": "int32" } } }, "PaymentRequest": { "required": [ "redirectUrl" ], "type": "object", "properties": { "cardInfo": { "$ref": "#/components/schemas/CardInfo" }, "browserInfo": { "$ref": "#/components/schemas/BrowserInfo" }, "redirectUrl": { "$ref": "#/components/schemas/RedirectUrl" }, "modifyPaymentMethod": { "type": "boolean" }, "nonInteractive": { "type": "boolean" } } }, "RedirectUrl": { "required": [ "acceptUrl", "declineUrl", "exceptionUrl" ], "type": "object", "properties": { "acceptUrl": { "type": "string" }, "declineUrl": { "type": "string" }, "exceptionUrl": { "type": "string" } } }, "PaymentResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "paymentId": { "type": "string" } } }, "BillingPlan": { "required": [ "billingUnitType" ], "type": "object", "properties": { "billingUnitAmount": { "type": "integer" }, "billingUnitType": { "type": "string", "enum": [ "ORGANIZATION", "EMPLOYEE", "PERSON" ] } } }, "AdjustUnitsPaymentRequest": { "type": "object", "properties": { "paymentRequest": { "$ref": "#/components/schemas/PaymentRequest" }, "billingPlans": { "type": "array", "items": { "$ref": "#/components/schemas/BillingPlan" } } } }, "AttachmentEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "remark": { "type": "string" }, "size": { "type": "integer" }, "mimeType": { "type": "string" }, "content": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "Article": { "required": [ "articleId", "type" ], "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE", "BUNDLE" ] }, "articleId": { "type": "string" }, "name": { "$ref": "#/components/schemas/TranslationEntity" }, "description": { "$ref": "#/components/schemas/TranslationEntity" }, "imageId": { "type": "integer" }, "categoryId": { "type": "integer" }, "measurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "unitCost": { "type": "string" }, "unitPrice": { "type": "string" }, "vatRateId": { "type": "integer" }, "saleAccountId": { "type": "integer" }, "saleAccountName": { "$ref": "#/components/schemas/Translation" }, "categoryName": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyEntity" }, "ean": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BundleArticleItem" } }, "isManufactured": { "type": "boolean" }, "isLinkedToShipments": { "type": "boolean" }, "archived": { "type": "boolean" }, "quantity": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "margin": { "type": "number" }, "weightKg": { "type": "number" }, "localizations": { "$ref": "#/components/schemas/TranslationEntity" } } }, "BundleArticleItem": { "required": [ "articleId" ], "type": "object", "properties": { "id": { "type": "integer" }, "articleId": { "type": "integer" }, "price": { "type": "string" }, "amount": { "type": "string" }, "discount": { "type": "string" }, "totalPrice": { "type": "string" }, "articleName": { "$ref": "#/components/schemas/Translation" } } }, "CurrencyEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "AllocationRule": { "required": [ "dateFrom", "filters", "moduleType", "name" ], "type": "object", "properties": { "id": { "type": "integer" }, "moduleType": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "filters": { "type": "string" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationRuleAction" } } } }, "AllocationRuleAction": { "required": [ "percentage" ], "type": "object", "properties": { "id": { "type": "integer" }, "position": { "type": "integer" }, "departmentId": { "type": "integer" }, "officeId": { "type": "integer" }, "accountId": { "type": "integer" }, "percentage": { "type": "number" }, "validAllocationUnit": { "type": "boolean" } } }, "AccountingPeriod": { "required": [ "endDate", "fiscalYear", "lockedUntil", "startDate", "vatRule" ], "type": "object", "properties": { "id": { "type": "integer" }, "fiscalYear": { "type": "integer", "format": "int32" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "vatRule": { "$ref": "#/components/schemas/VatRule" }, "ntdrRate_1": { "type": "string" }, "ntdrRate1AccountsIds": { "type": "array", "items": { "type": "integer" } }, "ntdrRate_2": { "type": "string" }, "ntdrRate2AccountsIds": { "type": "array", "items": { "type": "integer" } }, "flatRateAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/FlatRateAccount" } }, "status": { "type": "string", "enum": [ "OPEN", "CLOSED", "INACTIVE" ] }, "isLocked": { "type": "boolean" }, "budgetExist": { "type": "boolean" }, "lockedUntil": { "type": "string" } } }, "FlatRateAccount": { "type": "object", "properties": { "id": { "type": "integer" }, "flatRate": { "type": "string" }, "flatRateChartAccountsIds": { "type": "array", "items": { "type": "integer" } } } }, "VatRule": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "$ref": "#/components/schemas/Translation" }, "rule": { "type": "string", "enum": [ "NONE", "AGREED_SERVICE", "RECEIVED_COMPENSATION", "NTDR_AGREED_SERVICE", "NTDR_RECEIVED_COMPENSATION", "FLAT_RATE_RECEIVED_COMPENSATION", "FLAT_RATE_AGREED_SERVICE", "SIMPLE_TAX_RATE" ] } } }, "Payments": { "required": [ "chartOfAccountsId", "valueDate" ], "type": "object", "properties": { "valueDate": { "type": "string" }, "chartOfAccountsId": { "type": "integer" }, "purchasePayments": { "type": "array", "items": { "type": "integer" } }, "salesPayments": { "type": "array", "items": { "type": "integer" } }, "payrollPayments": { "type": "array", "items": { "type": "integer" } }, "bankCharges": { "type": "string" }, "lossOnDebtors": { "type": "string" } } }, "WorkflowView": { "type": "object", "properties": { "id": { "type": "integer" }, "moduleType": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "organizationId": { "type": "integer" }, "creatorContactId": { "type": "integer" }, "isActive": { "type": "boolean" } } }, "Ratio": { "type": "object", "properties": { "ratioType": { "type": "string", "enum": [ "CASH_RATIO", "QUICK_RATIO", "CURRENT_RATIO", "GROSS_MARGIN", "NET_MARGIN", "RETURN_ON_ASSETS", "RETURN_ON_EQUITY", "RETURN_ON_CAPITAL", "INTEREST_COVERAGE", "DEBT_RATIO", "DEBT_TO_EQUITY", "CAPITALIZATION_RATIO", "ASSET_TURNOVER", "INVENTORY_TURNOVER" ] }, "ratioGroup": { "type": "string", "enum": [ "LIQUIDITY_RATIOS", "PROFITABILITY_RATIOS", "DEBT_RATIOS", "EFFICIENCY_RATIOS" ] }, "value": { "type": "number" }, "lastYearValue": { "type": "number" }, "industryAverage": { "type": "number" } } }, "VatReportLine": { "type": "object", "properties": { "code": { "type": "string" }, "value": { "type": "number" }, "rightValue": { "type": "number" }, "rate": { "type": "number" }, "reportType": { "type": "string", "enum": [ "NONE", "AGREED_SERVICE", "RECEIVED_COMPENSATION", "NTDR_AGREED_SERVICE", "NTDR_RECEIVED_COMPENSATION", "FLAT_RATE_RECEIVED_COMPENSATION", "FLAT_RATE_AGREED_SERVICE", "SIMPLE_TAX_RATE" ] } } }, "VatPreview": { "type": "object", "properties": { "previousPeriods": { "$ref": "#/components/schemas/VatPreviewLine" }, "currentQuarter": { "$ref": "#/components/schemas/VatPreviewLine" } } }, "VatPreviewLine": { "type": "object", "properties": { "quarter": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "asOf": { "type": "string", "format": "date-time" }, "amount": { "type": "number" } } }, "VacationBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "employeeName": { "type": "string" } } }, "Period": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } } }, "VacationAvailability": { "type": "object", "properties": { "employeeId": { "type": "integer" }, "employeeName": { "type": "string", "writeOnly": true }, "salaryPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/Period" } }, "employeeIdName": { "type": "string" } } }, "UserGroupView": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "GROUP", "SUPER_GROUP" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "organizationId": { "type": "integer" }, "creatorContactId": { "type": "integer" } } }, "UserGroupAdvancedView": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "GROUP", "SUPER_GROUP" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "organizationId": { "type": "integer" }, "userIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "TreasuryInfo": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/TreasuryLine" } }, "totalLine": { "$ref": "#/components/schemas/TreasuryLine" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } } }, "TreasuryLine": { "type": "object", "properties": { "chartOfAccount": { "$ref": "#/components/schemas/UserLanguageChartOfAccountsView" }, "currency": { "type": "string" }, "amount": { "type": "number" }, "lastEntryDate": { "type": "string", "format": "date-time" }, "chartOfAccountsName": { "$ref": "#/components/schemas/Translation" } } }, "UserLanguageChartOfAccountsView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "accountNumber": { "type": "integer" }, "name": { "$ref": "#/components/schemas/Translation" }, "endDate": { "type": "string", "format": "date-time" }, "currency": { "type": "string" }, "currencyId": { "type": "integer" }, "type": { "type": "string" }, "departmentId": { "type": "integer" }, "warnings": { "type": "string" }, "isCashAccountEnabled": { "type": "boolean" }, "isActive": { "type": "boolean" }, "hasDepreciation": { "type": "boolean" }, "isPurchaseInvoicesEnabled": { "type": "boolean" } } }, "TrashCanView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "time": { "type": "string", "format": "date-time" }, "localTime": { "type": "string", "format": "date-time" }, "contactId": { "type": "integer" }, "contactEmail": { "type": "string" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "entityId": { "type": "integer" }, "entityName": { "type": "string" }, "systemInfo": { "type": "string" }, "entityCreatorContactId": { "type": "integer" }, "tenantId": { "type": "integer" } } }, "TimesheetView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "employeeContactId": { "type": "integer" }, "employee": { "type": "string" }, "client": { "type": "string" }, "clientContactId": { "type": "integer" }, "order": { "type": "string" }, "description": { "type": "string" }, "time": { "type": "number" }, "isBillable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "REJECTED", "APPROVED", "BILLED" ] }, "billableAmount": { "type": "number" }, "costAmount": { "type": "number" }, "taskName": { "type": "string" }, "billableRate": { "type": "number" }, "costRate": { "type": "number" }, "departmentId": { "type": "number" }, "orderIdOriginal": { "type": "string" }, "orderId": { "type": "integer" }, "workflowPermissions": { "type": "string" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" } } }, "TeamReview": { "type": "object", "properties": { "hours": { "type": "number" }, "hoursByStatus": { "type": "object", "additionalProperties": { "type": "number" } }, "billableHours": { "type": "number" }, "billableHoursPercent": { "type": "number" }, "capacity": { "type": "number" }, "employeeContactId": { "type": "integer" }, "employeeName": { "type": "string" }, "containSubmitted": { "type": "boolean" } } }, "EmployeeTeamReview": { "type": "object", "properties": { "hours": { "type": "number" }, "hoursByStatus": { "type": "object", "additionalProperties": { "type": "number" } }, "billableHours": { "type": "number" }, "billableHoursPercent": { "type": "number" }, "capacity": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "containSubmitted": { "type": "boolean" } } }, "OrderForTimesheet": { "type": "object", "properties": { "id": { "type": "integer" }, "orderId": { "type": "string" }, "name": { "type": "string" }, "clientId": { "type": "integer" }, "clientContactId": { "type": "integer" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTask" } } } }, "OrderBrief": { "type": "object", "properties": { "id": { "type": "integer" }, "orderId": { "type": "string" }, "name": { "type": "string" }, "clientId": { "type": "integer" }, "clientContactId": { "type": "integer" } } }, "TimesheetFilter": { "type": "object", "properties": { "employees": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ContactBrief" } }, "clientIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "orders": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/OrderBrief" } } } }, "TimesheetAdvancedView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "employeeContactId": { "type": "integer" }, "employee": { "type": "string" }, "client": { "type": "string" }, "clientContactId": { "type": "integer" }, "order": { "type": "string" }, "description": { "type": "string" }, "time": { "type": "number" }, "isBillable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "REJECTED", "APPROVED", "BILLED" ] }, "billableAmount": { "type": "number" }, "costAmount": { "type": "number" }, "taskName": { "type": "string" }, "billableRate": { "type": "number" }, "costRate": { "type": "number" }, "departmentId": { "type": "number" }, "orderIdOriginal": { "type": "string" }, "orderId": { "type": "integer" }, "workflowPermissions": { "type": "string" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "orderContactId": { "type": "integer" }, "orderName": { "type": "string" }, "orderJoinedId": { "type": "string" }, "orderStatus": { "type": "string" }, "parentOrderId": { "type": "integer" }, "orderDepartmentId": { "type": "integer" }, "orderHistoryStatus": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "orderHistoryDate": { "type": "string", "format": "date-time" }, "orderVatRateId": { "type": "integer" }, "orderRequestedPaymentTerms": { "type": "integer", "format": "int32" }, "orderOurContactName": { "type": "string" }, "orderCurrencyId": { "type": "integer" }, "orderMinimumAmountToInvoice": { "type": "number" }, "orderYourContactName": { "type": "string" }, "orderPeriodicityType": { "type": "string", "enum": [ "NONE", "DAILY", "WEEKLY", "BI_WEEKLY", "EVERY_MONTH", "EVERY_2_MONTH", "EVERY_3_MONTH", "EVERY_4_MONTH", "EVERY_6_MONTH", "ANNUAL" ] }, "orderDayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "orderInvoicingTime": { "type": "string", "enum": [ "FIRST_DAY", "LAST_DAY", "FIRST_WORKING_DAY", "LAST_WORKING_DAY" ] }, "orderPeriodicityStartDate": { "type": "string", "format": "date-time" }, "orderIsDisbursementFeeEnabled": { "type": "boolean" }, "orderIsExpensesEnabled": { "type": "boolean" }, "orderIsTimesheetsEnabled": { "type": "boolean" }, "orderFixedAmount": { "type": "number" }, "orderArticleId": { "type": "integer" }, "orderArticleAmount": { "type": "number" }, "orderArticleStatus": { "type": "string", "enum": [ "SHIPPED", "PARTIALLY_SHIPPED", "NOT_SHIPPED", "SERVICE" ] }, "orderOfficeId": { "type": "integer" } } }, "SubOrderView": { "type": "object", "properties": { "id": { "type": "integer" }, "invoicingDate": { "type": "string", "format": "date-time" }, "contactName": { "type": "string" }, "orderId": { "type": "string" }, "orderName": { "type": "string" }, "amount": { "type": "number" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "orderPeriodicityType": { "type": "string", "enum": [ "NONE", "DAILY", "WEEKLY", "BI_WEEKLY", "EVERY_MONTH", "EVERY_2_MONTH", "EVERY_3_MONTH", "EVERY_4_MONTH", "EVERY_6_MONTH", "ANNUAL" ] }, "organizationId": { "type": "integer" }, "totalAmount": { "type": "number" }, "workflowPermissions": { "type": "string" }, "orderOriginalId": { "type": "integer" } } }, "StockReportLineView": { "type": "object", "properties": { "articleId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "articleName": { "$ref": "#/components/schemas/Translation" }, "measurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "organizationId": { "type": "integer" }, "articleIdToDisplay": { "type": "string" }, "totalQuantity": { "type": "number" }, "totalCost": { "type": "number" }, "outQuantity": { "type": "number" }, "inQuantity": { "type": "number" }, "quantityProjection": { "type": "number" }, "departmentId": { "type": "number" }, "categoryId": { "type": "number" }, "officeId": { "type": "integer" } } }, "StockMovementLineView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "articleRealId": { "type": "integer" }, "articleId": { "$ref": "#/components/schemas/Translation" }, "movementDirection": { "type": "string", "enum": [ "IN", "OUT" ] }, "quantity": { "type": "number" }, "type": { "type": "string", "enum": [ "MANUAL", "SHIPMENT" ] }, "cost": { "type": "number" }, "currencyCode": { "type": "string" }, "quantityLeft": { "type": "number" }, "organizationId": { "type": "integer" }, "ownerId": { "type": "integer" }, "ownerType": { "type": "string", "enum": [ "PURCHASE_INVOICE", "SALES_INVOICE", "ORDER" ] }, "measurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "entityCreatorContactId": { "type": "integer" } } }, "StockMovementLineAdvancedView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "articleRealId": { "type": "integer" }, "articleId": { "$ref": "#/components/schemas/Translation" }, "movementDirection": { "type": "string", "enum": [ "IN", "OUT" ] }, "quantity": { "type": "number" }, "type": { "type": "string", "enum": [ "MANUAL", "SHIPMENT" ] }, "cost": { "type": "number" }, "currencyCode": { "type": "string" }, "quantityLeft": { "type": "number" }, "organizationId": { "type": "integer" }, "ownerId": { "type": "integer" }, "ownerType": { "type": "string", "enum": [ "PURCHASE_INVOICE", "SALES_INVOICE", "ORDER" ] }, "measurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "departmentId": { "type": "integer" }, "orderId": { "type": "integer" }, "contactId": { "type": "integer" }, "comment": { "type": "string" }, "ean": { "type": "string" }, "officeId": { "type": "integer" } } }, "DeletedSalesInvoice": { "required": [ "clientId", "currencyId", "date", "invoiceLines" ], "type": "object", "properties": { "id": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "number": { "type": "string" }, "date": { "type": "string" }, "clientId": { "type": "integer" }, "clientAddressId": { "type": "integer" }, "address": { "$ref": "#/components/schemas/Address" }, "ourContactId": { "type": "integer" }, "yourContactId": { "type": "integer" }, "clientName": { "type": "string" }, "reference": { "type": "string" }, "yourReference": { "type": "string" }, "currencyId": { "type": "integer" }, "description": { "type": "string" }, "comments": { "type": "string" }, "warnings": { "type": "string" }, "receivableAccountId": { "type": "integer" }, "vatTypeCodeId": { "type": "integer" }, "excludedFromVat": { "type": "boolean" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceLine" } }, "invoiceLinesLayout": { "type": "array", "items": { "$ref": "#/components/schemas/SalesInvoiceLineLayout" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPayment" } }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderShipment" } }, "timesheetInfoItems": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTimesheetInfo" } }, "sourceOrderId": { "type": "integer" }, "sourceSubOrderId": { "type": "integer" }, "bvrGenerationAvailability": { "type": "boolean" }, "qrGenerationAvailability": { "type": "boolean" }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "isContainsFixedAsset": { "type": "boolean" }, "accrualFrom": { "type": "string" }, "accrualTo": { "type": "string" }, "accrualEntriesAmount": { "type": "integer", "format": "int32" }, "validated": { "type": "boolean" }, "validatorUserIdsSize": { "type": "integer" }, "validatorUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "realValidated": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "canEditProformaFlag": { "type": "boolean" }, "isDocSent": { "type": "boolean", "readOnly": true }, "ourContactName": { "type": "string" }, "yourContactName": { "type": "string" }, "receivableAccountName": { "$ref": "#/components/schemas/Translation" }, "clientAddressName": { "type": "string" }, "proforma": { "type": "boolean" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } } }, "SalesInvoiceBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "number": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "client": { "type": "string" }, "clientId": { "type": "integer" }, "reference": { "type": "string" }, "description": { "type": "string" }, "referenceAndDescriptionJoined": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "receivable": { "type": "number" }, "status": { "type": "string", "enum": [ "OPEN", "UNPAID", "PAID", "PARTIALLY_PAID", "OVERDUE", "PRO_FORMA" ] }, "comments": { "type": "string" }, "warnings": { "type": "string" }, "ourContactName": { "type": "string" }, "clientEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "bvrGenerationAvailability": { "type": "boolean" }, "qrGenerationAvailability": { "type": "boolean" }, "creatorContactId": { "type": "integer" }, "validated": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "hasComments": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "clientBillingEmail": { "type": "string" }, "hasShipments": { "type": "boolean" }, "isDocSent": { "type": "boolean" }, "inWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" } } }, "SalesInvoiceBaseAdvancedView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "number": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "client": { "type": "string" }, "clientId": { "type": "integer" }, "reference": { "type": "string" }, "description": { "type": "string" }, "referenceAndDescriptionJoined": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "receivable": { "type": "number" }, "status": { "type": "string", "enum": [ "OPEN", "UNPAID", "PAID", "PARTIALLY_PAID", "OVERDUE", "PRO_FORMA" ] }, "comments": { "type": "string" }, "warnings": { "type": "string" }, "ourContactName": { "type": "string" }, "clientEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "bvrGenerationAvailability": { "type": "boolean" }, "qrGenerationAvailability": { "type": "boolean" }, "creatorContactId": { "type": "integer" }, "validated": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "hasComments": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "clientBillingEmail": { "type": "string" }, "hasShipments": { "type": "boolean" }, "isDocSent": { "type": "boolean" }, "addressClientName": { "type": "string" }, "addressStreet": { "type": "string" }, "addressStreetPoBox": { "type": "string" }, "addressZipCode": { "type": "string" }, "addressCity": { "type": "string" }, "addressCountryCode": { "type": "string" }, "addressRegionCode": { "type": "string" }, "addressToTheAttentionOf": { "type": "string" }, "salesInvoiceLineId": { "type": "integer" }, "invoiceLineDescription": { "type": "string" }, "invoiceLineSaleAccountId": { "type": "integer" }, "invoiceLineSaleAccountNumber": { "type": "integer" }, "invoiceLineQuantity": { "type": "number" }, "invoiceLineTotalNet": { "type": "number" }, "invoiceLineVatPercent": { "type": "number" }, "invoiceLineVat": { "type": "number" }, "invoiceLineTotalPrice": { "type": "number" }, "invoiceLineNetPrice": { "type": "number" }, "invoiceLineDiscount": { "type": "number" }, "invoiceLineDepartmentId": { "type": "integer" }, "invoiceLineDepartmentName": { "type": "string" }, "invoiceLineArticleId": { "type": "integer" }, "invoiceLineArticleIdToDisplay": { "type": "string" }, "invoiceLineAllocationKeys": { "type": "string" }, "invoiceLineOfficeId": { "type": "integer" }, "invoiceLineOfficeName": { "type": "string" }, "paymentId": { "type": "integer" }, "paymentReceivableByAccountNumber": { "type": "integer" }, "paymentReceivableByAccountId": { "type": "integer" }, "paymentRequestedDate": { "type": "string", "format": "date-time" }, "paymentOverdueDate": { "type": "string", "format": "date-time" }, "paymentValueDate": { "type": "string", "format": "date-time" }, "paymentRequestedCurrency": { "type": "string" }, "paymentRequestedAmount": { "type": "number" }, "paymentPaidCurrency": { "type": "string" }, "paymentPaidAmount": { "type": "number" }, "paymentBankCharges": { "type": "number" }, "paymentLossOnDebtors": { "type": "number" }, "paymentBvrNumber": { "type": "string" }, "paymentQrNumber": { "type": "string" }, "paymentBvrQrNumber": { "type": "string" }, "specificBalanceSheetAccountId": { "type": "integer" }, "vatCodeEntityId": { "type": "integer" }, "excludedFromVat": { "type": "boolean" }, "yourReference": { "type": "string" }, "ourContactId": { "type": "integer" }, "inWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" } } }, "InvoiceAccounting": { "type": "object", "properties": { "emissionEntry": { "$ref": "#/components/schemas/JournalEntry" }, "paymentEntries": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntry" } } } }, "OrganizationRegistry": { "type": "object", "properties": { "id": { "type": "integer" }, "lastRegistryPublicationDate": { "type": "string" }, "deletionDate": { "type": "string" }, "name": { "type": "string" }, "uid": { "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "BEING_CANCELLED", "CANCELLED" ] }, "nominalCapital": { "type": "integer" }, "address": { "$ref": "#/components/schemas/Address" }, "currencyCode": { "type": "string" }, "legalFormLocalizations": { "$ref": "#/components/schemas/Translation" }, "registryOfCommerceName": { "type": "string" }, "auditCompanyName": { "type": "string" } } }, "RegistryOfCommerce": { "type": "object", "properties": { "organizationRegistryName": { "type": "string" }, "publicationDate": { "type": "string", "format": "date-time" }, "publication": { "type": "string" } } }, "ReconciliationLineView": { "type": "object", "properties": { "id": { "type": "integer" }, "processDate": { "type": "string", "format": "date-time" }, "movementDirection": { "type": "string", "enum": [ "IN", "OUT" ] }, "contactName": { "type": "string" }, "reference": { "type": "string" }, "valueDate": { "type": "string", "format": "date-time" }, "paidCurrencyCode": { "type": "string" }, "paidAmount": { "type": "number" }, "referredDocumentType": { "type": "string", "enum": [ "PURCHASE_INVOICE", "SALES_INVOICE", "PAYSLIP", "MANUAL" ] }, "isMatch": { "type": "boolean" }, "isInternalContact": { "type": "boolean" }, "organizationId": { "type": "integer" } } }, "ReceivableView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "paymentId": { "type": "integer" }, "invoiceId": { "type": "integer" }, "invoiceDate": { "type": "string", "format": "date-time" }, "requestedDate": { "type": "string", "format": "date-time" }, "invoiceNumber": { "type": "string" }, "requestedAmount": { "type": "number" }, "comment": { "type": "string" }, "warnings": { "type": "string" }, "chartId": { "type": "integer" }, "contact": { "type": "string" }, "contactId": { "type": "integer" }, "chartName": { "$ref": "#/components/schemas/Translation" }, "chartNumber": { "type": "integer" }, "currency": { "type": "string" }, "currencyId": { "type": "integer" }, "hasWarnings": { "type": "boolean" }, "entityCreatorContactId": { "type": "integer" }, "paymentFileReference": { "type": "string" }, "tenantId": { "type": "integer" } } }, "InvoiceContactInfo": { "type": "object", "properties": { "contactId": { "type": "integer" }, "contactName": { "type": "string" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodContainerBigDecimal" } }, "total": { "type": "number" } } }, "PeriodContainerBigDecimal": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "data": { "type": "number" } } }, "PurchaseInvoiceView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "supplier": { "type": "string" }, "supplierId": { "type": "integer" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "payable": { "type": "number" }, "status": { "type": "string", "enum": [ "UNPAID", "OVERDUE", "PAID", "PARTIALLY_PAID", "WIRED", "DRAFT" ] }, "validated": { "type": "boolean" }, "comment": { "type": "string" }, "warnings": { "type": "string" }, "fileId": { "type": "integer" }, "fileExtension": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "shipmentsCount": { "type": "integer" }, "creatorContactId": { "type": "integer" }, "workflowPermissions": { "type": "string" }, "hasComments": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "systemValidated": { "type": "boolean" } } }, "DeletedPurchaseInvoice": { "required": [ "amounts", "currencyId", "date", "payments", "reference", "supplierId" ], "type": "object", "properties": { "id": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "organizationId": { "type": "integer" }, "date": { "type": "string" }, "supplierId": { "type": "integer" }, "currencyId": { "type": "integer" }, "reference": { "type": "string" }, "description": { "type": "string" }, "comment": { "type": "string" }, "validated": { "type": "boolean" }, "vatType": { "type": "string", "enum": [ "NO_VAT", "NATIVE", "IMPORT_OF_SERVICE" ] }, "vatTypeCodeId": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "amounts": { "type": "array", "items": { "$ref": "#/components/schemas/Amount" } }, "attributions": { "type": "array", "items": { "$ref": "#/components/schemas/Attribution" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/PurchasePayment" } }, "warnings": { "type": "string" }, "isFromLockedAccountingPeriod": { "type": "boolean" }, "accrualEntriesAmount": { "type": "integer", "format": "int32" }, "isDraft": { "type": "boolean" }, "validatorUserIdsSize": { "type": "integer" }, "validatorUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "realValidated": { "type": "boolean" }, "systemValidated": { "type": "boolean" }, "isContainsSoldFixedAsset": { "type": "boolean" }, "supplierName": { "type": "string" }, "paymentAccountName": { "$ref": "#/components/schemas/Translation" } } }, "PurchaseInvoiceBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "supplier": { "type": "string" }, "supplierId": { "type": "integer" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "payable": { "type": "number" }, "status": { "type": "string", "enum": [ "UNPAID", "OVERDUE", "PAID", "PARTIALLY_PAID", "WIRED", "DRAFT" ] }, "validated": { "type": "boolean" }, "comment": { "type": "string" }, "warnings": { "type": "string" }, "fileId": { "type": "integer" }, "fileExtension": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "shipmentsCount": { "type": "integer" }, "creatorContactId": { "type": "integer" }, "workflowPermissions": { "type": "string" }, "hasComments": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "systemValidated": { "type": "boolean" } } }, "BaseAdvancedFilterPurchaseInvoiceView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "journalEntryId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "supplier": { "type": "string" }, "supplierId": { "type": "integer" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "payable": { "type": "number" }, "status": { "type": "string", "enum": [ "UNPAID", "OVERDUE", "PAID", "PARTIALLY_PAID", "WIRED", "DRAFT" ] }, "validated": { "type": "boolean" }, "comment": { "type": "string" }, "warnings": { "type": "string" }, "fileId": { "type": "integer" }, "fileExtension": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "shipmentsCount": { "type": "integer" }, "creatorContactId": { "type": "integer" }, "workflowPermissions": { "type": "string" }, "hasComments": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "systemValidated": { "type": "boolean" }, "description": { "type": "string" }, "vatAmount": { "type": "number" }, "attributionId": { "type": "integer" }, "chartOfAccountsId": { "type": "integer" }, "attributionAccountNumber": { "type": "integer" }, "invoiceLineDepartmentId": { "type": "integer" }, "departmentName": { "type": "string" }, "orderId": { "type": "integer" }, "orderIdToDisplay": { "type": "string" }, "invoiceLineOfficeId": { "type": "integer" }, "invoiceLineOfficeName": { "type": "string" }, "reBill": { "type": "boolean" }, "reBilled": { "type": "boolean" }, "reBilledDate": { "type": "string", "format": "date-time" }, "articleId": { "type": "integer" }, "articleIdToDisplay": { "type": "string" }, "quantity": { "type": "number" }, "ruleName": { "type": "string" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "attributionNet": { "type": "number" }, "percent": { "type": "number" }, "paymentId": { "type": "integer" }, "requestedDate": { "type": "string", "format": "date-time" }, "plannedDate": { "type": "string", "format": "date-time" }, "sentDate": { "type": "string", "format": "date-time" }, "valueDate": { "type": "string", "format": "date-time" }, "paidAmount": { "type": "number" }, "bankCharges": { "type": "number" }, "payableByAccount": { "type": "integer" }, "payableByAccountNumber": { "type": "integer" }, "paymentType": { "type": "string", "enum": [ "BANK_TRANSFER", "BVR", "QR_BILL" ] }, "requestedCurrency": { "type": "string" }, "paidCurrency": { "type": "string" }, "requestedAmount": { "type": "number" }, "paymentAccountId": { "type": "integer" }, "vatType": { "type": "string", "enum": [ "NO_VAT", "NATIVE", "IMPORT_OF_SERVICE" ] }, "documentsExist": { "type": "boolean" } } }, "PurchaseInvoiceScanView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationName": { "type": "string" }, "organizationId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "supplier": { "type": "string" }, "currency": { "type": "string" }, "totalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "NEW", "PROCESS", "CONVERT", "RECOGNIZING" ] }, "isOrganizationNameIncluded": { "type": "boolean" }, "isTreatedByManagingOrganization": { "type": "boolean" }, "fileId": { "type": "integer" }, "warnings": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "comment": { "type": "string" } } }, "RecognizedDocument": { "type": "object", "properties": { "id": { "type": "integer" }, "templateId": { "type": "integer" }, "documentFileId": { "type": "integer" }, "documentWidth": { "type": "integer" }, "status": { "type": "string", "enum": [ "PENDING", "IN_PROGRESS", "FAIL", "SUCCESS" ] }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/RecognizedDocumentField" } }, "notPurchaseInvoice": { "type": "boolean" } } }, "RecognizedDocumentField": { "type": "object", "properties": { "id": { "type": "integer" }, "recognizedDocumentId": { "type": "integer" }, "fieldId": { "type": "string" }, "value": { "type": "string" }, "anchor": { "type": "boolean" } } }, "HierarchyElementObject": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "object" } }, "position": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer" }, "id": { "type": "integer" } } }, "PLAccountBalance": { "type": "object", "properties": { "accountId": { "type": "integer" }, "accountNumber": { "type": "integer" }, "account": { "$ref": "#/components/schemas/Translation" }, "balance": { "type": "number" }, "lastYearBalance": { "type": "number" }, "margin": { "type": "number" }, "lastYearMargin": { "type": "number" }, "change": { "type": "number" }, "changeAmount": { "type": "number" }, "changeAmountProportion": { "type": "number" }, "budget": { "$ref": "#/components/schemas/Budget" }, "lastYearBudget": { "$ref": "#/components/schemas/Budget" }, "ytdBudget": { "$ref": "#/components/schemas/Budget" }, "ytdBalance": { "type": "number" }, "ytdMargin": { "type": "number" }, "hasWarnings": { "type": "boolean" } } }, "PLReportLine": { "type": "object", "properties": { "templateLineName": { "$ref": "#/components/schemas/TranslationEntity" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/PLReportLine" } }, "sign": { "type": "string", "enum": [ "ASSETS", "LIABILITY", "INCOME", "EXPENSE" ] }, "type": { "type": "string", "enum": [ "NONE", "ACCOUNTS", "CALCULATIONS" ] }, "calculationTemplateLineIds": { "type": "array", "items": { "type": "integer" } }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodContainerPeriodData" } }, "accountBalances": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodContainerListPLAccountBalance" } }, "total": { "type": "number" }, "hasWarnings": { "type": "boolean" }, "id": { "type": "integer" }, "position": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer" } } }, "PeriodContainerListPLAccountBalance": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PLAccountBalance" } } } }, "PeriodContainerPeriodData": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "data": { "$ref": "#/components/schemas/PeriodData" } } }, "PeriodData": { "type": "object", "properties": { "total": { "type": "number" }, "margin": { "type": "number" }, "lastYearTotal": { "type": "number" }, "lastYearMargin": { "type": "number" }, "change": { "type": "number" }, "changeAmount": { "type": "number" }, "changeAmountProportion": { "type": "number" }, "budget": { "$ref": "#/components/schemas/Budget" }, "lastYearBudget": { "$ref": "#/components/schemas/Budget" }, "ytdBudget": { "$ref": "#/components/schemas/Budget" }, "ytd": { "type": "number" }, "ytdMargin": { "type": "number" } } }, "PdfTemplateView": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "templateType": { "type": "string", "enum": [ "SALES_INVOICE", "LATE_NOTICE", "SALARY_SLIP", "MY_SALARY_SLIP", "SALES_ORDER", "VAT_REPORT", "DELIVERY_NOTE", "GENERAL_LEDGER" ] }, "sourceTemplateId": { "type": "integer" }, "previewTemplateId": { "type": "integer" }, "previewImageId": { "type": "integer" }, "previewExists": { "type": "boolean" }, "moduleAvailabilityType": { "type": "string", "enum": [ "ORGANIZATION", "GLOBAL" ] }, "description": { "type": "string" } } }, "PayslipView": { "type": "object", "properties": { "id": { "type": "integer" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "calendarYear": { "type": "integer", "format": "int32" }, "countryName": { "$ref": "#/components/schemas/Translation" }, "countryId": { "type": "integer" }, "regionName": { "type": "string" }, "cla": { "type": "string" }, "type": { "type": "string", "enum": [ "COUNTRY", "REGION", "CLA" ] }, "isRegionAvailable": { "type": "boolean" }, "warnings": { "type": "string" } } }, "PayslipLineView": { "type": "object", "properties": { "id": { "type": "integer" }, "payslipId": { "type": "integer" }, "number": { "type": "integer" }, "name": { "$ref": "#/components/schemas/Translation" }, "type": { "type": "string", "enum": [ "EMPLOYEE_LINE", "COMPANY_LINE", "BOTH", "CALCULATION", "SYSTEM" ] }, "sign": { "type": "string", "enum": [ "INCOME", "CHARGES" ] }, "isAutomaticallyAdded": { "type": "boolean" }, "usedInRegionConfigWithinCalendarYear": { "type": "boolean" }, "usedInClaConfigWithinCalendarYear": { "type": "boolean" }, "visible": { "type": "boolean" } } }, "SourceTaxLine": { "type": "object", "properties": { "regionId": { "type": "integer" }, "regionCode": { "type": "string" }, "regionName": { "type": "string" }, "isUploaded": { "type": "boolean" } } }, "PayslipLineNameNumber": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "integer" }, "description": { "$ref": "#/components/schemas/Translation" }, "systemLine": { "oneOf": [ { "$ref": "#/components/schemas/SystemLine" }, { "$ref": "#/components/schemas/BothLine" }, { "$ref": "#/components/schemas/CalculationLine" }, { "$ref": "#/components/schemas/CompanyLine" }, { "$ref": "#/components/schemas/EmployeeLine" } ] }, "payslipEntityId": { "type": "integer" }, "calendarYear": { "type": "integer", "format": "int32" }, "isAutomaticallyAdded": { "type": "boolean" }, "isHourlyWageLine": { "type": "boolean" }, "payslipLineType": { "type": "string", "enum": [ "EMPLOYEE_LINE", "COMPANY_LINE", "BOTH", "CALCULATION", "SYSTEM" ] } } }, "PayslipLineNumberContainer": { "type": "object", "properties": { "claContributionTableLines": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLineNameNumber" } } }, "claSalaryTableLines": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLineNameNumber" } } } } }, "PayrollView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "calendarYear": { "type": "integer", "format": "int32" }, "monthNumber": { "type": "integer", "format": "int32" }, "monthType": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "paymentDate": { "type": "string", "format": "date-time" }, "employee": { "type": "string" }, "employeeId": { "type": "integer" }, "currencyCode": { "type": "string" }, "grossSalary": { "type": "number" }, "netSalary": { "type": "number" }, "payable": { "type": "number" }, "status": { "type": "string", "enum": [ "UNPAID", "PAID", "PARTIALLY_PAID", "WIRED" ] }, "warnings": { "type": "string" }, "employeeEmail": { "type": "string" }, "employeeECorrespondence": { "type": "boolean" }, "organizationEmployeeGroupName": { "type": "string" }, "organizationEmployeeGroupIds": { "type": "array", "items": { "type": "integer" } }, "isDocSent": { "type": "boolean" } } }, "EmployeePayrollView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "staffId": { "type": "integer" }, "payrollCurrencyId": { "type": "integer" }, "staffPayslipId": { "type": "integer" }, "staffAccountId": { "type": "integer" }, "name": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "salaryType": { "type": "string", "enum": [ "MONTHLY", "HOURLY" ] }, "genderType": { "type": "string", "enum": [ "MALE", "FEMALE", "OTHER" ] }, "birthday": { "type": "string", "format": "date-time" }, "isPayrollGenerated": { "type": "boolean" }, "payableToBankId": { "type": "integer" }, "orgEmployeeGroupIds": { "type": "array", "items": { "type": "integer" } }, "orgEmployeeGroupName": { "type": "string" }, "tenantId": { "type": "integer" } } }, "PayrollBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "calendarYear": { "type": "integer", "format": "int32" }, "monthNumber": { "type": "integer", "format": "int32" }, "monthType": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "paymentDate": { "type": "string", "format": "date-time" }, "employee": { "type": "string" }, "employeeId": { "type": "integer" }, "currencyCode": { "type": "string" }, "grossSalary": { "type": "number" }, "netSalary": { "type": "number" }, "payable": { "type": "number" }, "status": { "type": "string", "enum": [ "UNPAID", "PAID", "PARTIALLY_PAID", "WIRED" ] }, "warnings": { "type": "string" }, "employeeEmail": { "type": "string" }, "employeeECorrespondence": { "type": "boolean" }, "organizationEmployeeGroupName": { "type": "string" }, "organizationEmployeeGroupIds": { "type": "array", "items": { "type": "integer" } }, "isDocSent": { "type": "boolean" } } }, "OrganizationView": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "country": { "type": "string" }, "currency": { "type": "string" }, "parentCompanyName": { "type": "string" }, "warnings": { "type": "string" }, "externalId": { "type": "string" }, "archived": { "type": "boolean" }, "endDate": { "type": "string", "format": "date-time" }, "managingOrganizationId": { "type": "integer" }, "managingOrganizationName": { "type": "string" }, "isConsolidated": { "type": "boolean" }, "canViewDetails": { "type": "boolean" } } }, "OrganizationTemplateShortInfo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "DataForSalaryCodeView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "countryId": { "type": "integer" }, "calendarYear": { "type": "integer", "format": "int32" }, "payslipLineEntityId": { "type": "integer" }, "number": { "type": "integer" }, "localizations": { "$ref": "#/components/schemas/Translation" }, "payslipLineType": { "type": "string", "enum": [ "EMPLOYEE_LINE", "COMPANY_LINE", "BOTH", "CALCULATION", "SYSTEM" ] }, "payslipValueSplitType": { "type": "string", "enum": [ "EMPLOYEE", "EMPLOYER", "BOTH" ] }, "specialAttributionType": { "type": "string", "enum": [ "BASE_SALARY", "GROSS_SALARY", "NET_SALARY", "PAYABLE", "CHARGES", "EMPLOYEE_ALLOCATION", "SYSTEM_LINE_ADJUSTMENT" ] } } }, "SalaryCodesContainer": { "type": "object", "properties": { "yearToSalaryCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataForSalaryCodeView" } } }, "yearToClaSalaryCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataForSalaryCodeView" } } }, "yearToRegionSalaryCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataForSalaryCodeView" } } } } }, "EbicsServer": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "swiftBic": { "type": "string" } } }, "OrganizationCurrencyExchangeView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "currencyFrom": { "type": "string" }, "currencyTo": { "type": "string" }, "rate": { "type": "number" } } }, "OrderView": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "orderId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "contactName": { "type": "string" }, "contactId": { "type": "integer" }, "organizationId": { "type": "integer" }, "warnings": { "type": "string" }, "status": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "isExpensesEnabled": { "type": "boolean" }, "isPrePaymentAvailable": { "type": "boolean" }, "isPartialPaymentAvailable": { "type": "boolean" }, "orderAmount": { "type": "number" }, "creatorContactId": { "type": "integer" }, "hasWarnings": { "type": "boolean" }, "validated": { "type": "boolean" }, "clientEmail": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "isInvoiceGenerated": { "type": "boolean" }, "isPeriodic": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "activeSubOrderId": { "type": "integer" }, "activeSubOrderInvoicingDate": { "type": "string", "format": "date-time" }, "systemValidated": { "type": "boolean" }, "clientOrderEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "hasProformaInvoice": { "type": "boolean" }, "orderIdNameConcat": { "type": "string" }, "periodic": { "type": "boolean" }, "expensesEnabled": { "type": "boolean" }, "prePaymentAvailable": { "type": "boolean" }, "partialPaymentAvailable": { "type": "boolean" }, "invoiceGenerated": { "type": "boolean" }, "inWorkflow": { "type": "boolean" } } }, "PartiallyPaidOrderBrief": { "type": "object", "properties": { "articleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } }, "orderLineIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer" } } } }, "OrderAndView": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/Order" }, "view": { "$ref": "#/components/schemas/OrderBaseView" } } }, "OrderBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "orderId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "contactName": { "type": "string" }, "contactId": { "type": "integer" }, "organizationId": { "type": "integer" }, "warnings": { "type": "string" }, "status": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "isExpensesEnabled": { "type": "boolean" }, "isPrePaymentAvailable": { "type": "boolean" }, "isPartialPaymentAvailable": { "type": "boolean" }, "orderAmount": { "type": "number" }, "creatorContactId": { "type": "integer" }, "hasWarnings": { "type": "boolean" }, "validated": { "type": "boolean" }, "clientEmail": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "isInvoiceGenerated": { "type": "boolean" }, "isPeriodic": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "activeSubOrderId": { "type": "integer" }, "activeSubOrderInvoicingDate": { "type": "string", "format": "date-time" }, "systemValidated": { "type": "boolean" }, "clientOrderEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "hasProformaInvoice": { "type": "boolean" }, "periodic": { "type": "boolean" }, "expensesEnabled": { "type": "boolean" }, "prePaymentAvailable": { "type": "boolean" }, "partialPaymentAvailable": { "type": "boolean" }, "invoiceGenerated": { "type": "boolean" }, "inWorkflow": { "type": "boolean" } } }, "DeletedOrder": { "required": [ "contactId", "currencyId", "name", "periodicityConfiguration" ], "type": "object", "properties": { "id": { "type": "integer" }, "contactId": { "type": "integer" }, "contactName": { "type": "string" }, "orderId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "statusLastChangedDate": { "type": "string" }, "description": { "type": "string" }, "parentOrderId": { "type": "integer" }, "department": { "type": "integer" }, "vatRateId": { "type": "integer" }, "currencyId": { "type": "integer" }, "requestedPaymentTerms": { "type": "string" }, "orderValidity": { "type": "string" }, "minimumAmountToInvoice": { "type": "string" }, "ourContactId": { "type": "integer" }, "yourContactId": { "type": "integer" }, "periodicityConfiguration": { "$ref": "#/components/schemas/OrderPeriodicity" }, "isTimesheetsEnabled": { "type": "boolean" }, "timesheetsAccountId": { "type": "integer" }, "fixedAmount": { "type": "string" }, "timesheetsVatRateId": { "type": "integer" }, "timesheetsVat": { "type": "string" }, "timesheetsTotalPrice": { "type": "string" }, "timesheetsDescription": { "type": "string" }, "timesheetsLongDescription": { "type": "string" }, "timesheetsDiscount": { "maximum": 99.99, "exclusiveMaximum": false, "minimum": 0.0, "exclusiveMinimum": false, "type": "number" }, "timesheetsDepartmentId": { "type": "integer" }, "timesheetsOfficeId": { "type": "integer" }, "isExpensesEnabled": { "type": "boolean" }, "isDisbursementFeeEnabled": { "type": "boolean" }, "disbursementDepartmentId": { "type": "integer" }, "expensesDepartmentId": { "type": "integer" }, "office": { "type": "integer" }, "disbursementOfficeId": { "type": "integer" }, "expensesOfficeId": { "type": "integer" }, "includedArticles": { "type": "array", "items": { "$ref": "#/components/schemas/OrderArticle" } }, "orderLines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLine" } }, "orderElementsLayoutLines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderElementsLayoutLine" } }, "warnings": { "type": "string" }, "organizationId": { "type": "integer" }, "isInvoiceGenerated": { "type": "boolean" }, "hasOnlyPrepaymentsInvoices": { "type": "boolean" }, "yourReference": { "type": "string" }, "clientAddressId": { "type": "integer" }, "address": { "$ref": "#/components/schemas/Address" }, "clientName": { "type": "string" }, "statusHistories": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusHistory" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTask" } }, "clientHasVatType": { "type": "boolean" }, "validated": { "type": "boolean" }, "paymentAccountId": { "type": "integer" }, "validatorUserIdsSize": { "type": "integer" }, "validatorUserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "realValidated": { "type": "boolean" }, "activeSubOrderId": { "type": "integer" }, "activeSubOrderInvoicingDate": { "type": "string", "format": "date-time" }, "systemValidated": { "type": "boolean" }, "hasProformaInvoice": { "type": "boolean" }, "parentOrderName": { "type": "string" }, "departmentName": { "type": "string" }, "clientAddressName": { "type": "string" }, "ourContactName": { "type": "string" }, "yourContactName": { "type": "string" }, "timesheetsAccountName": { "$ref": "#/components/schemas/Translation" }, "paymentAccountName": { "$ref": "#/components/schemas/Translation" }, "periodic": { "type": "boolean" } } }, "OrderAdvancedView": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "orderId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "contactName": { "type": "string" }, "contactId": { "type": "integer" }, "organizationId": { "type": "integer" }, "warnings": { "type": "string" }, "status": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "isExpensesEnabled": { "type": "boolean" }, "isPrePaymentAvailable": { "type": "boolean" }, "isPartialPaymentAvailable": { "type": "boolean" }, "orderAmount": { "type": "number" }, "creatorContactId": { "type": "integer" }, "hasWarnings": { "type": "boolean" }, "validated": { "type": "boolean" }, "clientEmail": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "isInvoiceGenerated": { "type": "boolean" }, "isPeriodic": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "activeSubOrderId": { "type": "integer" }, "activeSubOrderInvoicingDate": { "type": "string", "format": "date-time" }, "systemValidated": { "type": "boolean" }, "clientOrderEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "hasProformaInvoice": { "type": "boolean" }, "parentOrderId": { "type": "integer" }, "parentOrderName": { "type": "string" }, "departmentId": { "type": "integer" }, "departmentName": { "type": "string" }, "officeId": { "type": "integer" }, "officeName": { "type": "string" }, "vatRateId": { "type": "integer" }, "vatRateName": { "$ref": "#/components/schemas/Translation" }, "requestedPaymentTerms": { "type": "integer", "format": "int32" }, "currencyId": { "type": "integer" }, "currency": { "type": "string" }, "minimumAmountToInvoice": { "type": "number" }, "ourContactName": { "type": "string" }, "yourContactName": { "type": "string" }, "periodicityStartDate": { "type": "string", "format": "date-time" }, "periodicityType": { "type": "string", "enum": [ "NONE", "DAILY", "WEEKLY", "BI_WEEKLY", "EVERY_MONTH", "EVERY_2_MONTH", "EVERY_3_MONTH", "EVERY_4_MONTH", "EVERY_6_MONTH", "ANNUAL" ] }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "invoicingTime": { "type": "string", "enum": [ "FIRST_DAY", "LAST_DAY", "FIRST_WORKING_DAY", "LAST_WORKING_DAY" ] }, "invoicingDay": { "type": "string" }, "isDisbursementFeeEnabled": { "type": "boolean" }, "isTimesheetsEnabled": { "type": "boolean" }, "timesheetsAccountId": { "type": "integer" }, "fixedAmount": { "type": "number" }, "orderArticleId": { "type": "integer" }, "orderArticleName": { "$ref": "#/components/schemas/Translation" }, "orderArticleMeasurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "orderArticleUnitPrice": { "type": "number" }, "orderArticleAmount": { "type": "number" }, "orderArticleDiscount": { "type": "number" }, "orderArticleTotalNet": { "type": "number" }, "orderArticleStatus": { "type": "string", "enum": [ "SHIPPED", "PARTIALLY_SHIPPED", "NOT_SHIPPED", "SERVICE" ] }, "historyStatus": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "historyDate": { "type": "string", "format": "date-time" }, "statusLastChangedDate": { "type": "string", "format": "date-time" }, "addressName": { "type": "string" }, "addressClientName": { "type": "string" }, "addressStreet": { "type": "string" }, "addressStreetPoBox": { "type": "string" }, "addressZipCode": { "type": "string" }, "addressCity": { "type": "string" }, "addressCountryCode": { "type": "string" }, "addressRegionCode": { "type": "string" }, "addressToTheAttentionOf": { "type": "string" }, "yourReference": { "type": "string" }, "orderValidity": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "periodic": { "type": "boolean" }, "expensesEnabled": { "type": "boolean" }, "prePaymentAvailable": { "type": "boolean" }, "partialPaymentAvailable": { "type": "boolean" }, "invoiceGenerated": { "type": "boolean" }, "inWorkflow": { "type": "boolean" } } }, "OrderInvoiceView": { "type": "object", "properties": { "id": { "type": "integer" }, "number": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "reference": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "receivable": { "type": "number" }, "status": { "type": "string", "enum": [ "OPEN", "UNPAID", "PAID", "PARTIALLY_PAID", "OVERDUE", "PRO_FORMA" ] }, "invoicedPercent": { "type": "number" }, "orderId": { "type": "integer" }, "organizationId": { "type": "integer" }, "entityCreatorContactId": { "type": "integer" }, "type": { "type": "string", "enum": [ "PREPAYMENT", "PARTIAL", "FINAL" ] }, "tenantId": { "type": "integer" } } }, "OrderExpenseView": { "type": "object", "properties": { "id": { "type": "integer" }, "orderId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "supplier": { "type": "string" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "number" }, "reBillable": { "type": "boolean" }, "purchaseInvoiceId": { "type": "integer" }, "salesInvoiceId": { "type": "integer" }, "reBillDate": { "type": "string", "format": "date-time" }, "invoiceNumber": { "type": "string" }, "organizationId": { "type": "integer" }, "purchaseInvoiceCreatorContactId": { "type": "integer" }, "salesInvoiceCreatorContactId": { "type": "integer" } } }, "OrderAdvancedBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "orderId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "contactName": { "type": "string" }, "contactId": { "type": "integer" }, "organizationId": { "type": "integer" }, "warnings": { "type": "string" }, "status": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "isExpensesEnabled": { "type": "boolean" }, "isPrePaymentAvailable": { "type": "boolean" }, "isPartialPaymentAvailable": { "type": "boolean" }, "orderAmount": { "type": "number" }, "creatorContactId": { "type": "integer" }, "hasWarnings": { "type": "boolean" }, "validated": { "type": "boolean" }, "clientEmail": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "workflowPermissions": { "type": "string" }, "isInvoiceGenerated": { "type": "boolean" }, "isPeriodic": { "type": "boolean" }, "isInWorkflow": { "type": "boolean" }, "flagsAmount": { "type": "integer", "format": "int32" }, "activeSubOrderId": { "type": "integer" }, "activeSubOrderInvoicingDate": { "type": "string", "format": "date-time" }, "systemValidated": { "type": "boolean" }, "clientOrderEmail": { "type": "string" }, "clientAdvancedInvoicingNote": { "type": "string" }, "hasProformaInvoice": { "type": "boolean" }, "parentOrderId": { "type": "integer" }, "parentOrderName": { "type": "string" }, "departmentId": { "type": "integer" }, "departmentName": { "type": "string" }, "officeId": { "type": "integer" }, "officeName": { "type": "string" }, "vatRateId": { "type": "integer" }, "vatRateName": { "$ref": "#/components/schemas/Translation" }, "requestedPaymentTerms": { "type": "integer", "format": "int32" }, "currencyId": { "type": "integer" }, "currency": { "type": "string" }, "minimumAmountToInvoice": { "type": "number" }, "ourContactName": { "type": "string" }, "yourContactName": { "type": "string" }, "periodicityStartDate": { "type": "string", "format": "date-time" }, "periodicityType": { "type": "string", "enum": [ "NONE", "DAILY", "WEEKLY", "BI_WEEKLY", "EVERY_MONTH", "EVERY_2_MONTH", "EVERY_3_MONTH", "EVERY_4_MONTH", "EVERY_6_MONTH", "ANNUAL" ] }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "invoicingTime": { "type": "string", "enum": [ "FIRST_DAY", "LAST_DAY", "FIRST_WORKING_DAY", "LAST_WORKING_DAY" ] }, "invoicingDay": { "type": "string" }, "isDisbursementFeeEnabled": { "type": "boolean" }, "isTimesheetsEnabled": { "type": "boolean" }, "timesheetsAccountId": { "type": "integer" }, "fixedAmount": { "type": "number" }, "orderArticleId": { "type": "integer" }, "orderArticleName": { "$ref": "#/components/schemas/Translation" }, "orderArticleMeasurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "orderArticleUnitPrice": { "type": "number" }, "orderArticleAmount": { "type": "number" }, "orderArticleDiscount": { "type": "number" }, "orderArticleTotalNet": { "type": "number" }, "orderArticleStatus": { "type": "string", "enum": [ "SHIPPED", "PARTIALLY_SHIPPED", "NOT_SHIPPED", "SERVICE" ] }, "historyStatus": { "type": "string", "enum": [ "OFFERED", "OFFERED_SENT", "CONFIRMED", "CONFIRMED_SENT", "BILLABLE", "FINISHED", "CANCELLED" ] }, "historyDate": { "type": "string", "format": "date-time" }, "statusLastChangedDate": { "type": "string", "format": "date-time" }, "addressName": { "type": "string" }, "addressClientName": { "type": "string" }, "addressStreet": { "type": "string" }, "addressStreetPoBox": { "type": "string" }, "addressZipCode": { "type": "string" }, "addressCity": { "type": "string" }, "addressCountryCode": { "type": "string" }, "addressRegionCode": { "type": "string" }, "addressToTheAttentionOf": { "type": "string" }, "yourReference": { "type": "string" }, "orderValidity": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "periodic": { "type": "boolean" }, "expensesEnabled": { "type": "boolean" }, "prePaymentAvailable": { "type": "boolean" }, "partialPaymentAvailable": { "type": "boolean" }, "invoiceGenerated": { "type": "boolean" }, "inWorkflow": { "type": "boolean" } } }, "OrderReportsView": { "type": "object", "properties": { "id": { "type": "integer" }, "orderId": { "type": "string" }, "orderName": { "type": "string" }, "organizationId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "NONE", "DAILY", "WEEKLY", "BI_WEEKLY", "EVERY_MONTH", "EVERY_2_MONTH", "EVERY_3_MONTH", "EVERY_4_MONTH", "EVERY_6_MONTH", "ANNUAL" ] }, "clientName": { "type": "string" }, "ourContactName": { "type": "string" }, "totalRevenue": { "type": "number" }, "totalCost": { "type": "number" }, "profitability": { "type": "number" }, "entityCreatorContactId": { "type": "integer" } } }, "OrderReportsDetailsLine": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "revenue": { "type": "number" }, "cost": { "type": "number" }, "profitability": { "type": "number" } } }, "SupplierExpenseReportView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "payable": { "type": "number" }, "status": { "type": "string", "enum": [ "UNPAID", "OVERDUE", "PAID", "PARTIALLY_PAID", "WIRED", "DRAFT" ] }, "validated": { "type": "boolean" } } }, "CurrentOrganizationDetails": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "currencyId": { "type": "integer" }, "countryCode2": { "type": "string" }, "regionId": { "type": "integer" }, "startDate": { "type": "string", "format": "date-time" }, "stockStrategy": { "type": "string", "enum": [ "FIFO", "LIFO", "AVERAGE", "UNIT", "TRADING" ] }, "defaultPaymentTerms": { "type": "integer", "format": "int32" }, "mainLanguage": { "$ref": "#/components/schemas/Language" }, "useTimesheets": { "type": "boolean" }, "isCustomEmailServerConfigured": { "type": "boolean" }, "employeeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationEmployeeGroup" } }, "payslipLineCodes": { "type": "array", "items": { "type": "string" } }, "plannedPaymentDateOffset": { "type": "integer", "format": "int32" }, "purchasePaymentAccountId": { "type": "integer" }, "salesPaymentAccountId": { "type": "integer" }, "usePurchaseAccrualAccounting": { "type": "boolean" }, "useSalesAccrualAccounting": { "type": "boolean" }, "validatePurchaseInvoicesByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "validateSalesInvoicesByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "validateOrdersByDefaultType": { "type": "string", "enum": [ "NONE", "SINGLE", "DOUBLE" ] }, "useUnsentPayrollStatus": { "type": "boolean" }, "useUnsentSalesStatus": { "type": "boolean" }, "useUnsentOrdersStatus": { "type": "boolean" }, "automaticSynchronizationOfContacts": { "type": "boolean" }, "isConsolidated": { "type": "boolean" } } }, "WorkflowNotificationView": { "type": "object", "properties": { "id": { "type": "integer" }, "workflowId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "moduleType": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "realModuleType": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "actionType": { "type": "string", "enum": [ "APPROVE", "STATUS_CONFIRMED", "ADVANCED_INVOICING", "GENERATE_PAYMENT", "GENERATE_PDF_SEND", "SEND_CONFIRMATION", "SEND_OFFER", "STATUS_BILLABLE", "VALIDATE" ] }, "entitiesAmount": { "type": "integer", "format": "int32" }, "entities": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "DayTimesheet": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "timeEntries": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } }, "total": { "type": "number" } } }, "WeekTimesheet": { "type": "object", "properties": { "dayTimesheets": { "type": "array", "items": { "$ref": "#/components/schemas/DayTimesheet" } }, "total": { "type": "number" }, "locked": { "type": "boolean" } } }, "ExpenseBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "merchant": { "type": "string" }, "description": { "type": "string" }, "reBill": { "type": "boolean" }, "currency": { "type": "string" }, "currencyNetAmount": { "type": "number" }, "currencyVatAmount": { "type": "number" }, "currencyTotalAmount": { "type": "number" }, "companyCurrencyTotalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "APPROVED", "REFUSED", "BILLED" ] }, "receipt": { "type": "boolean" }, "organizationId": { "type": "integer" } } }, "OrderForMyExpense": { "type": "object", "properties": { "id": { "type": "integer" }, "orderId": { "type": "string" }, "name": { "type": "string" }, "clientId": { "type": "integer" }, "isExpensesEnabled": { "type": "boolean" }, "orderIdNameConcat": { "type": "string" } } }, "Merchant": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "vatRateId": { "type": "integer" }, "chartOfAccountsId": { "type": "integer" } } }, "MyExpenseView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "merchant": { "type": "string" }, "description": { "type": "string" }, "reBill": { "type": "boolean" }, "currency": { "type": "string" }, "currencyNetAmount": { "type": "number" }, "currencyVatAmount": { "type": "number" }, "currencyTotalAmount": { "type": "number" }, "companyCurrencyTotalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "APPROVED", "REFUSED", "BILLED" ] }, "receipt": { "type": "boolean" }, "organizationId": { "type": "integer" } } }, "TranslatedWorkflowActionTypeDetails": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "supportedBlockTypes": { "type": "array", "items": { "type": "string", "enum": [ "TRIGGER", "ACTION" ] } } } }, "VatRate": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "$ref": "#/components/schemas/Translation" }, "percent": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "effectiveDate": { "type": "string" } } }, "RegistryMutation": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "$ref": "#/components/schemas/Translation" } } }, "PaymentPurposeCode": { "type": "object", "properties": { "id": { "type": "integer" }, "countryId": { "type": "integer" }, "code": { "type": "string" }, "purpose": { "$ref": "#/components/schemas/Translation" } } }, "NogaCode": { "type": "object", "properties": { "id": { "type": "integer" }, "section": { "type": "string" }, "code": { "type": "string" }, "description": { "$ref": "#/components/schemas/Translation" } } }, "Canton": { "type": "object", "properties": { "bfsCode": { "type": "string" }, "name": { "type": "string" } } }, "LanguageEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "Country": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "$ref": "#/components/schemas/Translation" }, "code2": { "type": "string" }, "code3": { "type": "string" } } }, "GeneralLedgerBaseView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "entryId": { "type": "integer" }, "entryDate": { "type": "string", "format": "date-time" }, "sortOrder": { "type": "integer", "format": "int32" }, "entryType": { "type": "string", "enum": [ "OPENING", "MANUAL", "PURCHASE_INVOICE", "SALES_INVOICE", "SALARY_SLIP", "STOCK", "CLOSING", "SYSTEM", "SYSTEM_FX", "SYSTEM_PFUV", "FIXED_ASSET" ] }, "accountId": { "type": "integer" }, "foreignCurrencyCode": { "type": "string" }, "foreignDebit": { "type": "number" }, "foreignCredit": { "type": "number" }, "foreignTotal": { "type": "number" }, "companyDebit": { "type": "number" }, "companyCredit": { "type": "number" }, "companyTotal": { "type": "number" }, "account": { "$ref": "#/components/schemas/Translation" }, "description": { "type": "string" }, "warnings": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "tenantId": { "type": "integer" } } }, "GeneralLedgerView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "entryId": { "type": "integer" }, "entryDate": { "type": "string", "format": "date-time" }, "sortOrder": { "type": "integer", "format": "int32" }, "entryType": { "type": "string", "enum": [ "OPENING", "MANUAL", "PURCHASE_INVOICE", "SALES_INVOICE", "SALARY_SLIP", "STOCK", "CLOSING", "SYSTEM", "SYSTEM_FX", "SYSTEM_PFUV", "FIXED_ASSET" ] }, "accountId": { "type": "integer" }, "foreignCurrencyCode": { "type": "string" }, "foreignDebit": { "type": "number" }, "foreignCredit": { "type": "number" }, "foreignTotal": { "type": "number" }, "companyDebit": { "type": "number" }, "companyCredit": { "type": "number" }, "companyTotal": { "type": "number" }, "account": { "$ref": "#/components/schemas/Translation" }, "description": { "type": "string" }, "warnings": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "tenantId": { "type": "integer" } } }, "AdvancedGeneralLedgerView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "entryId": { "type": "integer" }, "entryDate": { "type": "string", "format": "date-time" }, "sortOrder": { "type": "integer", "format": "int32" }, "entryType": { "type": "string", "enum": [ "OPENING", "MANUAL", "PURCHASE_INVOICE", "SALES_INVOICE", "SALARY_SLIP", "STOCK", "CLOSING", "SYSTEM", "SYSTEM_FX", "SYSTEM_PFUV", "FIXED_ASSET" ] }, "accountId": { "type": "integer" }, "foreignCurrencyCode": { "type": "string" }, "foreignDebit": { "type": "number" }, "foreignCredit": { "type": "number" }, "foreignTotal": { "type": "number" }, "companyDebit": { "type": "number" }, "companyCredit": { "type": "number" }, "companyTotal": { "type": "number" }, "account": { "$ref": "#/components/schemas/Translation" }, "description": { "type": "string" }, "warnings": { "type": "string" }, "hasWarnings": { "type": "boolean" }, "departmentName": { "type": "string" }, "contactName": { "type": "string" }, "articleName": { "$ref": "#/components/schemas/Translation" }, "orderName": { "type": "string" }, "vatCodeNames": { "$ref": "#/components/schemas/Translation" }, "tenantId": { "type": "integer" } } }, "LateNoticeLine": { "type": "object", "properties": { "clientId": { "type": "integer" }, "clientName": { "type": "string" }, "clientEmail": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "overdueAmount": { "type": "number" }, "openAmount": { "type": "number" }, "qrBillDataExists": { "type": "boolean" }, "clientLateNoticeEmail": { "type": "string" } } }, "LateNoticeView": { "type": "object", "properties": { "id": { "type": "integer" }, "salesInvoiceId": { "type": "integer" }, "salesInvoiceNumber": { "type": "string" }, "currencyId": { "type": "integer" }, "overdueAmount": { "type": "number" }, "noticeGeneratedQuantity": { "type": "integer", "format": "int32" }, "lastNoticeGeneratedDate": { "type": "string", "format": "date-time" }, "clientContactId": { "type": "integer" }, "overdueDate": { "type": "string", "format": "date-time" }, "organizationId": { "type": "integer" }, "daysOverdue": { "type": "integer", "format": "int32" }, "qrBillData": { "type": "string" }, "bvrGenerationAvailability": { "type": "boolean" }, "clientEmail": { "type": "string" }, "clientECorrespondence": { "type": "boolean" }, "entityCreatorContactId": { "type": "integer" }, "clientLateNoticeEmail": { "type": "string" } } }, "JournalEntryView": { "type": "object", "properties": { "id": { "type": "integer" }, "entryId": { "type": "integer" }, "organizationId": { "type": "integer" }, "entryDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "OPENING", "MANUAL", "PURCHASE_INVOICE", "SALES_INVOICE", "SALARY_SLIP", "STOCK", "CLOSING", "SYSTEM", "SYSTEM_FX", "SYSTEM_PFUV", "FIXED_ASSET" ] }, "amount": { "type": "number" }, "debitAccounts": { "type": "string" }, "creditAccounts": { "type": "string" }, "warnings": { "type": "string" }, "isDeleted": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "creatorContactId": { "type": "integer" }, "tenantId": { "type": "integer" } } }, "GlobalRoleView": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ROLE", "SUPER_ROLE" ] }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "integer" } } }, "FixedAssetReportView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "name": { "type": "string" }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "period": { "type": "string" }, "amortizationType": { "type": "string", "enum": [ "LINEAR_DEPRECIATION_DIRECT", "NON_LINEAR_DEPRECIATION_DIRECT", "LINEAR_DEPRECIATION_INDIRECT", "NON_LINEAR_DEPRECIATION_INDIRECT" ] }, "initialValue": { "type": "number" }, "amortization": { "type": "number" }, "actualValue": { "type": "number" }, "departmentId": { "type": "integer" }, "officeId": { "type": "integer" }, "chartOfAccountId": { "type": "integer" }, "soldOrDeleted": { "type": "boolean" } } }, "FixedAsset": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "saleDate": { "type": "string", "format": "date-time" }, "deletionDate": { "type": "string", "format": "date-time" }, "departmentId": { "type": "integer" }, "salesInvoiceId": { "type": "integer" }, "attributionId": { "type": "integer" }, "accountId": { "type": "integer" }, "officeId": { "type": "integer" } } }, "ExpenseView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "merchant": { "type": "string" }, "description": { "type": "string" }, "reBill": { "type": "boolean" }, "currency": { "type": "string" }, "currencyNetAmount": { "type": "number" }, "currencyVatAmount": { "type": "number" }, "currencyTotalAmount": { "type": "number" }, "companyCurrencyTotalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "APPROVED", "REFUSED", "BILLED" ] }, "receipt": { "type": "boolean" }, "organizationId": { "type": "integer" }, "employeeId": { "type": "integer" }, "employeeName": { "type": "string" } } }, "MerchantEntity": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "vatRateId": { "type": "integer" }, "chartOfAccountsId": { "type": "integer" } } }, "ExpenseDraftView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "merchant": { "type": "string" }, "description": { "type": "string" }, "reBill": { "type": "boolean" }, "currency": { "type": "string" }, "currencyNetAmount": { "type": "number" }, "currencyVatAmount": { "type": "number" }, "currencyTotalAmount": { "type": "number" }, "companyCurrencyTotalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "APPROVED", "REFUSED", "BILLED" ] }, "receipt": { "type": "boolean" }, "organizationId": { "type": "integer" }, "employeeId": { "type": "integer" }, "employeeName": { "type": "string" } } }, "DocumentView": { "type": "object", "properties": { "id": { "type": "integer" }, "entityId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "tags": { "type": "string" }, "tagsCount": { "type": "integer", "format": "int32" }, "contact": { "type": "string" }, "isContactStaff": { "type": "boolean" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "fileId": { "type": "integer" }, "fileName": { "type": "string" }, "fileExtension": { "type": "string" }, "size": { "type": "integer" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "creatorId": { "type": "integer" }, "comments": { "type": "string" }, "isDeleted": { "type": "boolean" }, "entityCreatorContactId": { "type": "integer" }, "self": { "type": "boolean" }, "deleted": { "type": "boolean" } } }, "DocumentScanView": { "type": "object", "properties": { "id": { "type": "integer" }, "entityId": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "tags": { "type": "string" }, "tagsCount": { "type": "integer", "format": "int32" }, "contact": { "type": "string" }, "isContactStaff": { "type": "boolean" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "fileId": { "type": "integer" }, "fileName": { "type": "string" }, "fileExtension": { "type": "string" }, "size": { "type": "integer" }, "createdOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "creatorId": { "type": "integer" }, "comments": { "type": "string" }, "isDeleted": { "type": "boolean" }, "entityCreatorContactId": { "type": "integer" }, "deleted": { "type": "boolean" } } }, "CurrencyExchangeView": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "currencyFrom": { "type": "string" }, "currencyTo": { "type": "string" }, "rate": { "type": "number" } } }, "ContactListView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "contactType": { "type": "string", "enum": [ "ORGANIZATION", "PERSON" ] }, "name": { "type": "string" }, "warnings": { "type": "string" }, "isCustomer": { "type": "boolean" }, "isVendor": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "isUser": { "type": "boolean" }, "email": { "type": "string" }, "externalId": { "type": "string" }, "clientOrderValidity": { "type": "integer" }, "creatorContactId": { "type": "integer" }, "archived": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "isEmployee": { "type": "boolean" }, "tenantId": { "type": "integer" } } }, "ContactSupplier": { "type": "object", "properties": { "id": { "type": "integer" }, "businessUnitId": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "balanceSheetAccountId": { "type": "integer" }, "currencyId": { "type": "integer" }, "paymentTerms": { "type": "string" }, "feeSplitType": { "type": "string", "enum": [ "CHARGED_TO_THE_BENEFICIARY", "FIFTY_FIFTY_SPLIT", "CHARGED_TO_THE_ORDERER" ] }, "contactId": { "type": "integer" }, "vatNumber": { "type": "string" }, "vatType": { "type": "string", "enum": [ "NO_VAT", "NATIVE", "IMPORT_OF_SERVICE" ] }, "vatTypeCodeId": { "type": "integer" }, "vatRateId": { "type": "integer" }, "businessUnitName": { "type": "string" }, "paymentAccountName": { "$ref": "#/components/schemas/Translation" }, "PLAccountName": { "$ref": "#/components/schemas/Translation" }, "balanceSheetAccountName": { "$ref": "#/components/schemas/Translation" }, "officeId": { "type": "integer" }, "countryId": { "type": "integer" }, "banks": { "type": "array", "items": { "$ref": "#/components/schemas/Bank" } }, "placcountId": { "type": "integer" }, "placcountName": { "$ref": "#/components/schemas/Translation" } } }, "ContactClient": { "type": "object", "properties": { "id": { "type": "integer" }, "businessUnitId": { "type": "integer" }, "paymentAccountId": { "type": "integer" }, "balanceSheetAccountId": { "type": "integer" }, "currencyId": { "type": "integer" }, "orderAddressId": { "type": "integer" }, "orderAddressName": { "type": "string" }, "invoiceAddressId": { "type": "integer" }, "invoiceAddressName": { "type": "string" }, "paymentTerms": { "type": "string" }, "lateNoticeMargin": { "type": "string" }, "clientDiscountRate": { "type": "string" }, "creditLimit": { "type": "string" }, "contactId": { "type": "integer" }, "vatNumber": { "type": "string" }, "advancedInvoicingNote": { "type": "string" }, "vatTypeCodeId": { "type": "integer" }, "vatRateId": { "type": "integer" }, "orderValidity": { "type": "string" }, "articleDiscounts": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleDiscount" } }, "businessUnitName": { "type": "string" }, "paymentAccountName": { "$ref": "#/components/schemas/Translation" }, "PLAccountName": { "$ref": "#/components/schemas/Translation" }, "balanceSheetAccountName": { "$ref": "#/components/schemas/Translation" }, "billingEmail": { "type": "string" }, "orderEmail": { "type": "string" }, "lateNoticeEmail": { "type": "string" }, "officeId": { "type": "integer" }, "countryId": { "type": "integer" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "organizationId": { "type": "integer" }, "placcountId": { "type": "integer" }, "placcountName": { "$ref": "#/components/schemas/Translation" } } }, "BalanceOfTheContact": { "type": "object", "properties": { "amount": { "type": "number" }, "currencyCode": { "type": "string" }, "description": { "type": "string" }, "entryDate": { "type": "string", "format": "date-time" } } }, "SupplierContactListView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "contactType": { "type": "string", "enum": [ "ORGANIZATION", "PERSON" ] }, "name": { "type": "string" }, "warnings": { "type": "string" }, "isCustomer": { "type": "boolean" }, "isVendor": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "isUser": { "type": "boolean" }, "email": { "type": "string" }, "externalId": { "type": "string" }, "clientOrderValidity": { "type": "integer" }, "creatorContactId": { "type": "integer" }, "archived": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "isEmployee": { "type": "boolean" }, "uid": { "type": "string" }, "tenantId": { "type": "integer" } } }, "StaffPayslipContainer": { "type": "object", "properties": { "systemLine": { "$ref": "#/components/schemas/PayslipLine" }, "baseSalaryLine": { "$ref": "#/components/schemas/PayslipLine" }, "employeeLines": { "type": "array", "items": { "$ref": "#/components/schemas/PayslipLine" } } } }, "BankMasterInfo": { "type": "object", "properties": { "swiftBic": { "type": "string" }, "bankName": { "type": "string" } } }, "ContactBalanceReportView": { "type": "object", "properties": { "id": { "type": "integer" }, "contactId": { "type": "integer" }, "contactName": { "type": "string" }, "contactRoleType": { "type": "string" }, "currencyCode": { "type": "string" }, "balance": { "type": "number" } } }, "ChartOfAccountsView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "accountNumber": { "type": "integer" }, "name": { "$ref": "#/components/schemas/Translation" }, "endDate": { "type": "string", "format": "date-time" }, "currency": { "type": "string" }, "currencyId": { "type": "integer" }, "type": { "type": "string" }, "departmentId": { "type": "integer" }, "warnings": { "type": "string" }, "isCashAccountEnabled": { "type": "boolean" }, "isActive": { "type": "boolean" }, "hasDepreciation": { "type": "boolean" }, "isPurchaseInvoicesEnabled": { "type": "boolean" } } }, "AccountMovement": { "type": "object", "properties": { "companyDebit": { "type": "number" }, "companyCredit": { "type": "number" } } }, "JournalChartOfAccountLine": { "type": "object", "properties": { "id": { "type": "integer" }, "accountNumber": { "type": "integer" }, "description": { "$ref": "#/components/schemas/Translation" }, "currencyId": { "type": "integer" }, "currency": { "type": "string" }, "endDate": { "type": "string" }, "departmentId": { "type": "integer" }, "hasDepreciation": { "type": "boolean" }, "isPurchaseInvoicesEnabled": { "type": "boolean" } } }, "CashFlowReportLine": { "type": "object", "properties": { "lineType": { "type": "string", "enum": [ "PROFIT_FOR_PERIOD", "DEPRECIATION_AND_IMPAIRMENT_LOSSES_ON_PROPERTY_AND_PLANT_AND_EQUIPMENT", "DEPRECIATION_ON_INVESTMENTS", "CHANGE_IN_OTHER_SHORT_TERM_RECEIVABLES", "CHANGE_IN_PRE_PAID_EXPENSES_AND_ACCRUED_INCOME", "CHANGE_IN_TRADE_ACCOUNT_PAYABLE", "CHANGE_IN_OTHER_SHORT_TERM_LIABILITIES", "CHANGE_IN_ACCRUED_EXPENSES_AND_DEFERRED_INCOME", "CHANGE_IN_PROVISIONS_FOR_TAXES", "CHANGE_IN_CASH_FLOW_RELATED_TO_INVESTMENTS", "CHANGE_IN_CASH_FLOW_RELATED_TO_FINANCING_ACTIVITIES", "CASH_POSITION", "TOTAL_OVERHEAD_COSTS", "CASH_POSITION_AT_START_DATE", "CASH_POSITION_AT_END_DATE", "CHANGE_IN_CASH_FLOW_RELATED_TO_OPERATIONAL_ACTIVITIES", "NET_CASH_CHANGE_1", "NET_CASH_CHANGE_2", "CASH_AND_CASH_EQUIVALENTS", "ACCOUNTS_RECEIVABLE", "CURRENT_LIABILITIES", "TOTAL_REVENUE", "GROSS_PROFIT", "NET_PROFIT", "SHORT_TERM_INVESTMENTS", "CURRENT_ASSETS", "TOTAL_ASSETS", "TOTAL_LIABILITIES", "LONG_TERM_DEBT", "SHAREHOLDER_S_EQUITY", "INVENTORY", "COST_OF_GOODS_SOLD", "EARNINGS_BEFORE_INTEREST_AND_TAX", "INTEREST_EXPENSE" ] }, "balance": { "type": "number" }, "lastYearBalance": { "type": "number" }, "hasWarnings": { "type": "boolean" } } }, "ExtrapolatedCashFlow": { "type": "object", "properties": { "week": { "type": "integer", "format": "int32" }, "cashInflow": { "type": "number" }, "cashOutflow": { "type": "number" }, "cashPosition": { "type": "number" } } }, "BudgetView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "fiscalYear": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "reportType": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "CASH_FLOW", "RATIOS" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "parent": { "type": "integer" }, "articleId": { "type": "integer" }, "contactId": { "type": "integer" }, "orderId": { "type": "integer" }, "departmentId": { "type": "integer" } } }, "BreakdownData": { "type": "object", "properties": { "contactName": { "type": "string" }, "amount": { "type": "number" } } }, "BillingUnitView": { "type": "object", "properties": { "id": { "type": "integer" }, "targetContactId": { "type": "integer" }, "unitId": { "type": "integer" }, "unitName": { "type": "string" }, "unitOrganizationId": { "type": "integer" }, "unitType": { "type": "string", "enum": [ "ORGANIZATION", "EMPLOYEE", "PERSON" ] } } }, "PaymentInfo": { "type": "object", "properties": { "cardNumber": { "type": "string" }, "expiryMonth": { "type": "integer", "format": "int32" }, "expiryYear": { "type": "integer", "format": "int32" } } }, "BillingPlanView": { "type": "object", "properties": { "id": { "type": "integer" }, "contactId": { "type": "integer" }, "billingUnitAmount": { "type": "integer" }, "availableBillingUnitsAmount": { "type": "integer" }, "billingUnitType": { "type": "string", "enum": [ "ORGANIZATION", "EMPLOYEE", "PERSON" ] } } }, "BillingPlanWithPrice": { "type": "object", "properties": { "billingPlan": { "type": "array", "items": { "$ref": "#/components/schemas/BillingPlanView" } }, "price": { "type": "number" } } }, "BalanceView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "accountNumber": { "type": "integer" }, "accountType": { "type": "string", "enum": [ "BALANCE_SHEET", "PL", "SYSTEM" ] }, "account": { "$ref": "#/components/schemas/Translation" }, "debit": { "type": "number" }, "credit": { "type": "number" }, "endingBalance": { "type": "number" }, "lastYearDebit": { "type": "number" }, "lastYearCredit": { "type": "number" }, "lastYearEndingBalance": { "type": "number" }, "warnings": { "type": "string" }, "tenantId": { "type": "integer" }, "accountId": { "type": "integer" } } }, "AccountBalance": { "type": "object", "properties": { "accountId": { "type": "integer" }, "accountNumber": { "type": "integer" }, "account": { "$ref": "#/components/schemas/Translation" }, "balance": { "type": "number" }, "lastYearBalance": { "type": "number" }, "margin": { "type": "number" }, "lastYearMargin": { "type": "number" }, "change": { "type": "number" }, "changeAmount": { "type": "number" }, "changeAmountProportion": { "type": "number" }, "hasWarnings": { "type": "boolean" } } }, "BalanceSheetLine": { "type": "object", "properties": { "templateLineName": { "$ref": "#/components/schemas/TranslationEntity" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceSheetLine" } }, "sign": { "type": "string", "enum": [ "ASSETS", "LIABILITY", "INCOME", "EXPENSE" ] }, "type": { "type": "string", "enum": [ "NONE", "ACCOUNTS", "CALCULATIONS" ] }, "calculationTemplateLineIds": { "type": "array", "items": { "type": "integer" } }, "total": { "type": "number" }, "margin": { "type": "number" }, "lastYearTotal": { "type": "number" }, "lastYearMargin": { "type": "number" }, "change": { "type": "number" }, "changeAmount": { "type": "number" }, "changeAmountProportion": { "type": "number" }, "accountBalances": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "hasWarnings": { "type": "boolean" }, "id": { "type": "integer" }, "position": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer" } } }, "MonthlyCash": { "type": "object", "properties": { "month": { "type": "integer", "format": "int32" }, "total": { "type": "number" }, "lastYearTotal": { "type": "number" } } }, "ArticleView": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE", "BUNDLE" ] }, "articleId": { "type": "string" }, "name": { "$ref": "#/components/schemas/Translation" }, "articleIdName": { "$ref": "#/components/schemas/Translation" }, "description": { "$ref": "#/components/schemas/Translation" }, "categoryId": { "type": "integer" }, "categoryName": { "type": "string" }, "measurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "unitCost": { "type": "number" }, "unitPrice": { "type": "number" }, "vatRateId": { "type": "integer" }, "archived": { "type": "boolean" }, "ean": { "type": "string" }, "creatorContactId": { "type": "integer" }, "quantity": { "type": "number" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "weightKg": { "type": "number" } } }, "LiteArticleItem": { "type": "object", "properties": { "id": { "type": "integer" }, "articleIdName": { "$ref": "#/components/schemas/Translation" } } }, "UserLanguageArticleView": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE", "BUNDLE" ] }, "articleId": { "type": "string" }, "name": { "$ref": "#/components/schemas/Translation" }, "articleIdName": { "$ref": "#/components/schemas/Translation" }, "description": { "$ref": "#/components/schemas/Translation" }, "categoryId": { "type": "integer" }, "categoryName": { "type": "string" }, "measurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "unitCost": { "type": "number" }, "unitPrice": { "type": "number" }, "vatRateId": { "type": "integer" }, "archived": { "type": "boolean" }, "ean": { "type": "string" }, "creatorContactId": { "type": "integer" }, "quantity": { "type": "number" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "weightKg": { "type": "number" } } }, "TranslatedArticleView": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE", "BUNDLE" ] }, "articleId": { "type": "string" }, "name": { "$ref": "#/components/schemas/Translation" }, "articleIdName": { "$ref": "#/components/schemas/Translation" }, "description": { "$ref": "#/components/schemas/Translation" }, "categoryId": { "type": "integer" }, "categoryName": { "type": "string" }, "measurement": { "type": "string", "enum": [ "UNIT", "ML", "DL", "L", "HL", "G", "KG", "T", "H", "M", "M_2", "M_3", "KM", "DAY" ] }, "unitCost": { "type": "number" }, "unitPrice": { "type": "number" }, "vatRateId": { "type": "integer" }, "archived": { "type": "boolean" }, "ean": { "type": "string" }, "creatorContactId": { "type": "integer" }, "quantity": { "type": "number" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "weightKg": { "type": "number" } } }, "AllocationRuleView": { "type": "object", "properties": { "id": { "type": "integer" }, "moduleType": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "organizationId": { "type": "integer" }, "isActive": { "type": "boolean" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" } } }, "ActivityLogView": { "type": "object", "properties": { "id": { "type": "integer" }, "organizationId": { "type": "integer" }, "dateTime": { "type": "string", "format": "date-time" }, "userId": { "type": "integer" }, "contactId": { "type": "integer" }, "entityId": { "type": "integer" }, "wtUser": { "type": "string" }, "contact": { "type": "string" }, "entity": { "type": "string" }, "module": { "type": "string", "enum": [ "ALL", "NONE", "CONTACTS", "CONTACTS_DETAILS", "CONTACTS_SUPPLIER", "CONTACTS_CLIENT", "CONTACTS_BALANCE", "CONTACTS_STAFF", "CONTACTS_STAFF_DOCUMENTS", "CONTACTS_USER", "CONTACTS_MAIN_USER", "CONTACTS_USER_SECURITY", "CONTACTS_USER_PERMISSIONS", "CONTACTS_SYSTEM", "CONTACTS_DOCUMENTS", "CONTACTS_ROLES", "CONTACTS_ROLES_SUPPLIER", "CONTACTS_ROLES_CLIENT", "CONTACTS_ROLES_STAFF", "CONTACTS_ROLES_USER", "CONTACTS_COMMUNICATIONS", "ORGANIZATIONS_USERS_MANAGER", "ORGANIZATIONS", "ORGANIZATIONS_DETAILS", "ORGANIZATIONS_TEMPLATES", "ORGANIZATIONS_ACCOUNTING", "ORGANIZATIONS_INVOICES", "ORGANIZATIONS_SYSTEM", "ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS", "ORGANIZATIONS_SYSTEM_CODES", "ORGANIZATIONS_SYSTEM_EBICS", "ORGANIZATIONS_SYSTEM_INVENTORY", "ORGANIZATIONS_DOCUMENTS", "ORGANIZATIONS_DETAILS_INVOICING", "PERMISSION_ROLES", "PERMISSION_ROLES_DETAILS", "BUSINESS_UNITS", "ARTICLE_CATEGORIES", "CHART_OF_ACCOUNTS", "CHART_OF_ACCOUNTS_DETAILS", "ACTIVITY_LOG", "CURRENCIES", "CURRENCIES_DETAILS", "JOURNAL", "JOURNAL_DETAILS", "JOURNAL_DOCUMENTS", "DOCUMENTS", "DOCUMENTS_DETAILS", "RECONCILIATION", "PURCHASE_INVOICES", "PURCHASE_INVOICES_DETAILS", "PURCHASE_INVOICES_VALIDATION", "PURCHASE_INVOICES_ACCOUNTING", "PURCHASE_INVOICES_SHIPMENTS", "PURCHASE_INVOICES_DOCUMENTS", "PURCHASE_INVOICES_ALLOCATION_RULES", "PURCHASE_INVOICES_WORKFLOW", "SALES_INVOICES", "SALES_INVOICES_DETAILS", "SALES_INVOICES_VALIDATION", "SALES_INVOICES_ACCOUNTING", "SALES_INVOICES_DOCUMENTS", "SALES_INVOICES_SHIPMENTS", "SALES_INVOICES_REPORT", "SALES_INVOICES_ALLOCATION_RULES", "SALES_INVOICES_WORKFLOW", "SALARIES", "STOCK_REPORT", "STOCK_MOVEMENTS", "STOCK_MOVEMENTS_DETAILS", "ORDERS", "ORDERS_DETAILS", "ORDERS_VALIDATION", "ORDERS_SHIPMENT", "ORDERS_INVOICES", "ORDERS_EXPENSES", "ORDERS_DOCUMENTS", "ORDERS_WORKFLOW", "ADVANCED_INVOICING", "ADVANCED_INVOICING_GENERATE", "ACCOUNTING_PERIODS", "ACCOUNTING_PERIODS_DETAILS", "ACCOUNTING_PERIODS_LOCK", "ACCOUNTING_PERIODS_OPEN_CLOSE", "GENERAL_LEDGER", "GENERAL_LEDGER_STAFF", "REPORT_TEMPLATE", "ARTICLES", "ARTICLES_DETAILS", "PURCHASE_INVOICES_SCAN", "PURCHASE_INVOICES_SCAN_DETAILS", "RECOGNIZER", "BALANCE", "BALANCE_SHEET", "BALANCE_SHEET_STAFF", "PL_REPORT", "PL_REPORT_STAFF", "CASH_FLOW_REPORT", "MY_TIMESHEETS", "MY_ACCOUNT", "TIME_DETAILS", "TIME_DETAILS_DETAILS", "TIME_DETAILS_WORKFLOW", "TEAM_REVIEW", "BUDGETING", "BUDGETING_DETAILS", "SALARY_CONFIG", "SALARY_CONFIG_DETAILS", "RECEIVABLES", "PAYABLES", "PAYABLES_PAYMENT_FILE", "PDF_TEMPLATES", "PDF_TEMPLATES_DETAILS", "DASHBOARD", "LATE_NOTICES", "MY_DOCUMENTS", "MY_DOCUMENTS_PAYROLL", "MY_DOCUMENTS_OTHER", "MY_DOCUMENTS_EXPORT_FILES", "PAYROLL", "PAYROLL_DETAILS", "PAYROLL_ACCOUNTING", "VAT_REPORT", "ORDER_REPORTS", "ORDER_REPORTS_DETAILS", "RATIOS_REPORT", "VACATIONS", "TRASH_CAN", "USER_GROUPS", "USER_GROUPS_DETAILS", "WORKFLOW", "WORKFLOW_DETAILS", "MY_WORKFLOW_NOTIFICATIONS", "FIXED_ASSETS", "UNASSIGNED", "EXPENSES", "EXPENSES_DETAILS", "EXPENSES_DRAFT", "EXPENSES_DRAFT_DETAILS", "CONTACT_BALANCE_REPORT", "ORGANIZATION_CURRENCIES", "ORGANIZATION_CURRENCIES_DETAILS", "FINANCIAL_STATEMENTS", "ALLOCATIONS", "ALLOCATIONS_DETAILS" ] }, "action": { "type": "string", "enum": [ "CREATE", "MODIFY", "DELETE", "LOGIN", "LOGOUT", "BLOCK", "CORRESPONDENCE", "RESTORE", "EXPORT", "VIEW_DATA" ] }, "actionType": { "type": "string", "enum": [ "VALIDATE", "INVALIDATE", "PARTIAL_VALIDATE", "DOCUMENT", "LOCK", "SHIPMENT", "REMINDER", "UNLOCK", "PAYSLIP_LINE", "PAYMENT", "EMAIL", "UPLOAD", "RECONCILIATION", "CLOSE", "OPEN", "SCAN", "BILLING_METHOD", "PAID", "PARTIALLY_PAID", "PARTIAL_PAYMENT_REMOVED", "PAYMENT_REMOVED", "SENT", "ARCHIVED", "UNARCHIVED", "PDF", "EXCEL" ] }, "details": { "type": "string" }, "tenantId": { "type": "integer" } } }, "AccountingPeriodView": { "type": "object", "properties": { "id": { "type": "integer" }, "fiscalYear": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "vatRuleId": { "type": "integer" }, "vatRule": { "$ref": "#/components/schemas/Translation" }, "status": { "type": "string", "enum": [ "OPEN", "CLOSED", "INACTIVE" ] }, "isLocked": { "type": "boolean" }, "lockedUntil": { "type": "string", "format": "date-time" } } }, "VatRuleView": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "$ref": "#/components/schemas/Translation" }, "rule": { "type": "string", "enum": [ "NONE", "AGREED_SERVICE", "RECEIVED_COMPENSATION", "NTDR_AGREED_SERVICE", "NTDR_RECEIVED_COMPENSATION", "FLAT_RATE_RECEIVED_COMPENSATION", "FLAT_RATE_AGREED_SERVICE", "SIMPLE_TAX_RATE" ] } } }, "DateLockStatus": { "type": "object", "properties": { "periodDetails": { "$ref": "#/components/schemas/AccountingPeriod" }, "locked": { "type": "boolean" } } }, "DeleteResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ErrorCode" }, "valid": { "type": "boolean" } } } } }, "host": "wyzio.app", "schemes": [ "https" ], "x-topics": [ { "title": "Authentication", "content": "API calls are authenticated via Web Tokens. At a high level, authentication works by the add-on exchanging a security context with the application. This context is used to create and validate tokens, embedded in API calls.\n\n- To use the API, you will need to retrieve the API credentials.\n- Create a Wyzio contact to handle the API requests at https://wyzio.app/contacts.\n- Give that contact the user role.\n- On the User tab, in the permissions area, apply to the contact the **Webservice** role.\n- Go to the RESTful API section.\n- A token linked to the account will be shown on this page.\n- When you generate a request to the REST API, pass in the header the key `WEAL-TOKEN` (Wyzio Enhanced API Library) and, as the value, the token of the user.\n- All calls must be made using `Wyzio/1.0` as User Agent." }, { "title": "Dates & time", "content": "## Formats\n\nFor specific points in time (often referred to as DateTimes), strings compliant with RFC-3339 can be used.\n\nNote that there are some restrictions that apply:\n\n- Only the T separator is supported (not a lowercased t or a whitespace or any other character)\n- The `unknown offset` -00:00 is not supported\n- For dates (without a specific time indication), the same format as the date section of RFC-3339 can be used, e.g. 2022-08-17.\n- For times (without a specific date indication), the military time format (HH:mm) can be used, e.g. 19:05.\n\n## Time zone\n\nWyzio REST API are based on CET Time Zone." }, { "title": "Versioning and backwards compatibility", "content": "Wyzio API is versioned by path (/api-v1/...). When we introduce breaking changes, we will increase this version number. We will, of course, continually make backward-compatible changes without increasing the version number.\n\nExamples of changes we do not consider breaking include:\n\n- Adding new API resources.\n- Adding new optional request parameters to existing API methods.\n- Adding new properties to existing API responses. We will occasionally move response fields in the API and will continue to return the existing field in its previous location while removing it from this documentation.\n- Changing the order of properties in existing API responses.\n- Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings. Strings that are marked as const or enum in this documentation will not change." }, { "title": "Compression", "content": "To improve performance and reduce bandwidth usage, Wyzio API supports HTTP response compression.\n\n## How it works\n\nWhen your client includes an `Accept-Encoding` header specifying one or more supported compression algorithms, the server will automatically compress the response using a matching algorithm.\n\nThe response will then include a `Content-Encoding` header indicating which algorithm was applied.\n\nIf no preference is specified (`*`), the server will default to gzip.\n\n## Example request\n\n```\nGET /api-v1/contact HTTP/1.1\nHost: wyzio.app\nAccept-Encoding: gzip\n```\n\n## Example response\n\n```\nHTTP/1.1 200 OK\nContent-Encoding: gzip\nContent-Type: application/json\n...\n```\n\n## Supported algorithms\n\nThe API only supports the following compression methods:\n\n- `gzip` : Gzip compression\n- `*` : No specific preference (defaults to gzip)\n\n> **Note:** The list of supported compression algorithms may be extended or changed in the future.\n\n## Best practices\n\n- Compression is automatically applied by the server if the `Accept-Encoding` header is supplied; no additional configuration is required.\n- Be aware that compression can increase CPU usage on both client and server sides.\n- For very small payloads, compression may not provide a significant benefit." }, { "title": "Errors", "content": "Wyzio API uses standard HTTP response codes to indicate the success or failure of requests. Codes in the `2xx` range indicate success; codes in the `4xx` and `5xx` ranges indicate errors. The format of error messages is unified and can be distinguished by their `code` key. The message provides a plain English explanation of the problem." } ] }