{
"openapi": "3.0.1",
"info": {
"title": "Taxxo API",
"description": "\r\nContact us - if have any questions or suggestions for our API
\r\nAPI Newsletter - sign up to receive updates on the latest API changes
\r\n
\r\nColumb Technologies S.A.
\r\nTaxxo platform
\r\n",
"version": "v1"
},
"paths": {
"/api/public/authenticate": {
"post": {
"tags": [
"General"
],
"summary": "Authenticate access based on provided secretKey for API account (generated in UI). \r\nReturns SessionToken that should be added to the header to all other API calls.",
"operationId": "ApiPublicAuthenticatePost",
"parameters": [
{
"name": "culture",
"in": "query",
"description": "Optional. API communication culture (i.e. en-US, pl-PL, etc.)",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Account related API Key - provided in API section",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/authenticateByQuery": {
"get": {
"tags": [
"General"
],
"summary": "Authenticate access based on provided secretKey in query for API account (generated in UI). \r\nFor use in PowerBI, MS Excel PowerQuery\r\nReturns SessionToken that should be added to the header to all other API calls.",
"operationId": "ApiPublicAuthenticateByQueryGet",
"parameters": [
{
"name": "ApiKey",
"in": "query",
"description": "Account related API Key - provided in API section",
"schema": {
"type": "string"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional. API communication culture (i.e. en-US, pl-PL, etc.)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/authenticateWithUser": {
"post": {
"tags": [
"General"
],
"summary": "Authenticate access based on provided secretKey for API account (generated in UI) AND user and password.\r\nAPI Account must be set tu FULL PERMISSION\r\n\r\nINFO: The action context will be set to the indicated user by login\r\n\r\nReturns SessionToken that should be added to the header to all other API calls.",
"operationId": "ApiPublicAuthenticateWithUserPost",
"requestBody": {
"description": "Object with secretKey, user login and password",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAuthenticateRequestWithUser"
}
],
"description": "API Authentication request with User info"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAuthenticateRequestWithUser"
}
],
"description": "API Authentication request with User info"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAuthenticateRequestWithUser"
}
],
"description": "API Authentication request with User info"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAuthenticateRequestWithUser"
}
],
"description": "API Authentication request with User info"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/logout": {
"get": {
"tags": [
"General"
],
"summary": "Logout from current session.\r\n(No error if current session already expired)",
"operationId": "ApiPublicLogoutGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document data by providing system-generated ID\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentByDocumentIdGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultOneAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Documents"
],
"summary": "Update document",
"operationId": "ApiPublicDocumentByDocumentIdPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "executeRules",
"in": "query",
"description": "Execute rules on document, only ULTRA+ - optional, no if missing, (0) - no, (1) - yes",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "document object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocument"
}
],
"description": "Document (add or modify operation)"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Documents"
],
"summary": "Delete document",
"operationId": "ApiPublicDocumentByDocumentIdDelete",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/simple": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document data (simple type) by providing system-generated ID\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentByDocumentIdSimpleGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/file": {
"get": {
"tags": [
"Documents"
],
"summary": "Download file (byte array content)\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentByDocumentIdFileGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentFileDetailsAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/ksefXML": {
"get": {
"tags": [
"Documents"
],
"summary": "Download KSeF XML file (byte array content)\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentByDocumentIdKsefXMLGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentFileDetailsAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/accountingData": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document accounting data (with ledger lines bases on tags/allocation rows) by providing system-generated ID\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentByDocumentIdAccountingDataGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentAccountingDataAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/byNumber": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document data by providing document number",
"operationId": "ApiPublicDocumentByNumberGet",
"parameters": [
{
"name": "number",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultOneAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/byKsefNumber": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document data by providing KSeF number",
"operationId": "ApiPublicDocumentByKsefNumberGet",
"parameters": [
{
"name": "ksefNumber",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultOneAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/byInvoiceId/{invoiceId}": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document data by providing system-generated invoice ID",
"operationId": "ApiPublicDocumentByInvoiceIdByInvoiceIdGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "Invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultOneAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/externalUrl": {
"get": {
"tags": [
"Documents"
],
"summary": "Get system direct URL to download/preview document\r\n(no user-login required, GUID-like link generated)\r\n\r\nThis method supports delegation",
"operationId": "ApiPublicDocumentByDocumentIdExternalUrlGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/url": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document URL \r\n(requires user login to access)",
"operationId": "ApiPublicDocumentByDocumentIdUrlGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all documents from selected period\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentsGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tag",
"in": "query",
"description": "filter to tag - optional",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/costs": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all cost documents from selected period\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentsCostsGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tag",
"in": "query",
"description": "filter to tag - optional",
"schema": {
"type": "string"
}
},
{
"name": "isFromKsef",
"in": "query",
"description": "document comes from KSeF - optional, all if missing, (0) - all, (-1) - no, (1) - yes",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isAccepted",
"in": "query",
"description": "document is accepted - optional, all if missing, (0) - all, (-1) - no, (1) - yes",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/unpaid": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all unpaid documents\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentsUnpaidGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/recentlyAdded": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all NEW documents (added in last 7 days)\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentsRecentlyAddedGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/readyToBook": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all ready to book documents",
"operationId": "ApiPublicDocumentsReadyToBookGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "customFieldNameOrId",
"in": "query",
"description": "custom field name or Id - optional",
"schema": {
"type": "string"
}
},
{
"name": "customFieldValue",
"in": "query",
"description": "custom field value - optional",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/readyToExternalProcess": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all documents ready to external process",
"operationId": "ApiPublicDocumentsReadyToExternalProcessGet",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "limit number of documents (optional)",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ksefFilterMode",
"in": "query",
"description": "KSeF mode (optional): 0/null - all documents, 1 - non-KSeF documents only, 2 - non-KSeF + KSeF offline",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/toCheck": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all documents to check / verification",
"operationId": "ApiPublicDocumentsToCheckGet",
"parameters": [
{
"name": "year",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/byVehicleNumber": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all documents connected with vehicle by providing vehicle registration number",
"operationId": "ApiPublicDocumentsByVehicleNumberGet",
"parameters": [
{
"name": "registrationNumber",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/forReimbursement": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all documents for settlement with employees",
"operationId": "ApiPublicDocumentsForReimbursementGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/myReimbursement": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all documents to settle with me",
"operationId": "ApiPublicDocumentsMyReimbursementGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/lastModified": {
"get": {
"tags": [
"Documents"
],
"summary": "Get all documents that were modified after date that was provided - maximum 6 months (default value if not provided)",
"operationId": "ApiPublicDocumentsLastModifiedGet",
"parameters": [
{
"name": "modifiedFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document": {
"post": {
"tags": [
"Documents"
],
"summary": "Add new document\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentPost",
"parameters": [
{
"name": "executeRules",
"in": "query",
"description": "Execute rules on document, only ULTRA+ - optional, no if missing, (0) - no, (1) - yes",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Document object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocument"
}
],
"description": "Document (add or modify operation)"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/ksef": {
"post": {
"tags": [
"Documents"
],
"summary": "Add new document from KSeF XML.",
"operationId": "ApiPublicDocumentKsefPost",
"requestBody": {
"description": "KSeF import request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentKSeFImportRequest"
}
],
"description": "Request model for importing a KSeF invoice from XML via Public API."
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/setAsPaid": {
"put": {
"tags": [
"Documents"
],
"summary": "Update document - set as paid\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicDocumentByDocumentIdSetAsPaidPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "lastSettlementDate",
"in": "query",
"description": "(optional) last settlement date - current date-time if not given",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/setAsProcessed": {
"put": {
"tags": [
"Documents"
],
"summary": "Mark document as externally processed",
"operationId": "ApiPublicDocumentByDocumentIdSetAsProcessedPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/accept": {
"put": {
"tags": [
"Documents"
],
"summary": "Accept document (if accaptance process is on)",
"operationId": "ApiPublicDocumentByDocumentIdAcceptPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/setNotes": {
"put": {
"tags": [
"Documents"
],
"summary": "Set document Note",
"operationId": "ApiPublicDocumentByDocumentIdSetNotesPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "notes",
"in": "query",
"description": "Notes",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/checkVATStatus": {
"put": {
"tags": [
"Documents"
],
"summary": "Check VAT Status of contractor and save in documents meta-data",
"operationId": "ApiPublicDocumentByDocumentIdCheckVATStatusPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/checkBankAccountStatus": {
"put": {
"tags": [
"Documents"
],
"summary": "Check bank account number is related to customer (in gov whitelist) and save in documents meta-data",
"operationId": "ApiPublicDocumentByDocumentIdCheckBankAccountStatusPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/reportDigitalizationProblem": {
"post": {
"tags": [
"Documents"
],
"summary": "Report digitalization problem",
"operationId": "ApiPublicDocumentByDocumentIdReportDigitalizationProblemPost",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDigitalizationProblem"
}
],
"description": "Digitalization problem object"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDigitalizationProblem"
}
],
"description": "Digitalization problem object"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDigitalizationProblem"
}
],
"description": "Digitalization problem object"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDigitalizationProblem"
}
],
"description": "Digitalization problem object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/setIsToClarify": {
"put": {
"tags": [
"Documents"
],
"summary": "Set document need clarification",
"operationId": "ApiPublicDocumentByDocumentIdSetIsToClarifyPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "notes",
"in": "query",
"description": "optional notes",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/markAsClarified": {
"put": {
"tags": [
"Documents"
],
"summary": "Mark document as clarified",
"operationId": "ApiPublicDocumentByDocumentIdMarkAsClarifiedPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/markAsAccounted": {
"put": {
"tags": [
"Documents"
],
"summary": "Mark document as accounted",
"operationId": "ApiPublicDocumentByDocumentIdMarkAsAccountedPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/markAsNotAccounted": {
"put": {
"tags": [
"Documents"
],
"summary": "Mark docment as not accounted (if mark as accounted by accident)",
"operationId": "ApiPublicDocumentByDocumentIdMarkAsNotAccountedPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/documents/accountCategories": {
"get": {
"tags": [
"Documents"
],
"summary": "All categories used for documents accounting",
"operationId": "ApiPublicDocumentsAccountCategoriesGet",
"parameters": [
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAccountCategoryIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/documents/accountCategory": {
"post": {
"tags": [
"Documents"
],
"summary": "Add new category for documents accounting",
"operationId": "ApiPublicDocumentsAccountCategoryPost",
"parameters": [
{
"name": "AccountCategoryId",
"in": "query",
"description": "Category ID",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "AccountCategoryName",
"in": "query",
"description": "Category name",
"schema": {
"type": "string"
}
},
{
"name": "Type",
"in": "query",
"description": "Category type: -1 - costs document, 1 - revenue documents; 0 - unknown documents",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BarcodeRegex",
"in": "query",
"description": "Regular expression based on barcode to detect category",
"schema": {
"type": "string"
}
},
{
"name": "ParentId",
"in": "query",
"description": "Category parent ID",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsGroup",
"in": "query",
"description": "If category is a group",
"schema": {
"type": "boolean"
}
},
{
"name": "IsDefault",
"in": "query",
"description": "If category is default in group",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/documents/cycleCosts/missing": {
"get": {
"tags": [
"Documents"
],
"summary": "All missing recurring documents from previous month",
"operationId": "ApiPublicDocumentsCycleCostsMissingGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICycleCostMissingDocumentIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/attachments/internal/addFile": {
"put": {
"tags": [
"Documents"
],
"summary": "Add internal attachments to document - only for Power or higher accounts level",
"operationId": "ApiPublicDocumentByDocumentIdAttachmentsInternalAddFilePut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of document internal attachments",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/attachments/internal/addURL": {
"put": {
"tags": [
"Documents"
],
"summary": "Add internal url attachments to document - only for Power or higher accounts level",
"operationId": "ApiPublicDocumentByDocumentIdAttachmentsInternalAddURLPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of url attachments",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/attachments/internal/addRelated": {
"put": {
"tags": [
"Documents"
],
"summary": "Add internal related attachments to document - only for Power or higher accounts level",
"operationId": "ApiPublicDocumentByDocumentIdAttachmentsInternalAddRelatedPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of attachments related to document",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/attachments/internal": {
"get": {
"tags": [
"Documents"
],
"summary": "Get internal attachments for document - only for Power or higher accounts level",
"operationId": "ApiPublicDocumentByDocumentIdAttachmentsInternalGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInternalAttachmentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/attachments/internal/count": {
"get": {
"tags": [
"Documents"
],
"summary": "Get internal attachment counts for document grouped by type - only for Power or higher accounts level",
"operationId": "ApiPublicDocumentByDocumentIdAttachmentsInternalCountGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInternalAttachmentCountResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/document/{documentId}/attachments/internal/{internalAttachmentId}": {
"delete": {
"tags": [
"Documents"
],
"summary": "Delete document internal attachment - only for Power or higher accounts level",
"operationId": "ApiPublicDocumentByDocumentIdAttachmentsInternalByInternalAttachmentIdDelete",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "internalAttachmentId",
"in": "path",
"description": "internal attachment id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractor/{contractorId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get contractor data by providing system-generated ID",
"operationId": "ApiPublicInvoicesContractorByContractorIdGet",
"parameters": [
{
"name": "contractorId",
"in": "path",
"description": "Contractor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIContractorResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Invoices"
],
"summary": "Update contractor",
"operationId": "ApiPublicInvoicesContractorByContractorIdPut",
"parameters": [
{
"name": "contractorId",
"in": "path",
"description": "Contractor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Contractor object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractor"
}
],
"description": "Contractor object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete contractor",
"operationId": "ApiPublicInvoicesContractorByContractorIdDelete",
"parameters": [
{
"name": "contractorId",
"in": "path",
"description": "Contractor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractor/byName": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get contractor data by providing contractor name",
"operationId": "ApiPublicInvoicesContractorByNameGet",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Contractor name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIContractorResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractors/search": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get contractors data by providing text to search. The search is performed by the tax identifier, name and email.",
"operationId": "ApiPublicInvoicesContractorsSearchGet",
"parameters": [
{
"name": "searchText",
"in": "query",
"description": "Text to search",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of results - optional, 50 if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIContractorResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractors/last": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get last contractors data by providing invoice serie",
"operationId": "ApiPublicInvoicesContractorsLastGet",
"parameters": [
{
"name": "seriesCode",
"in": "query",
"description": "Code of invoice series - optional, default series if missing, * if all series",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of last contractors - optional, 10 if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIContractorResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractor/byIdentifier": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get contractor data by providing contractor identifier",
"operationId": "ApiPublicInvoicesContractorByIdentifierGet",
"parameters": [
{
"name": "identifier",
"in": "query",
"description": "Contractor identifier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIContractorResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractors": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all contractors",
"operationId": "ApiPublicInvoicesContractorsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIContractorResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractor/external/byIdentifier": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get contractor data from external service by providing contractor identifier",
"operationId": "ApiPublicInvoicesContractorExternalByIdentifierGet",
"parameters": [
{
"name": "identifier",
"in": "query",
"description": "Contractor identifier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIContractorResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/contractor": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add new contractor",
"operationId": "ApiPublicInvoicesContractorPost",
"requestBody": {
"description": "Contractor object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractor"
}
],
"description": "Contractor object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/factor/{factorId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get factor data by providing system-generated ID",
"operationId": "ApiPublicInvoicesFactorByFactorIdGet",
"parameters": [
{
"name": "factorId",
"in": "path",
"description": "Factor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIFactorResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Invoices"
],
"summary": "Update factor",
"operationId": "ApiPublicInvoicesFactorByFactorIdPut",
"parameters": [
{
"name": "factorId",
"in": "path",
"description": "Factor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Factor object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIFactor"
}
],
"description": "Factor object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete factor",
"operationId": "ApiPublicInvoicesFactorByFactorIdDelete",
"parameters": [
{
"name": "factorId",
"in": "path",
"description": "Factor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/factor/byName": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get factor data by providing factor name",
"operationId": "ApiPublicInvoicesFactorByNameGet",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Factor name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIFactorResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/factor/byIdentifier": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get factor data by providing factor identifier",
"operationId": "ApiPublicInvoicesFactorByIdentifierGet",
"parameters": [
{
"name": "identifier",
"in": "query",
"description": "Factor identifier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIFactorResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/factors": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all factors",
"operationId": "ApiPublicInvoicesFactorsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIFactorResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/factor/{factorId}/activate": {
"put": {
"tags": [
"Invoices"
],
"summary": "Activate factor",
"operationId": "ApiPublicInvoicesFactorByFactorIdActivatePut",
"parameters": [
{
"name": "factorId",
"in": "path",
"description": "Factor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/factor/{factorId}/deactivate": {
"put": {
"tags": [
"Invoices"
],
"summary": "Deactivate factor",
"operationId": "ApiPublicInvoicesFactorByFactorIdDeactivatePut",
"parameters": [
{
"name": "factorId",
"in": "path",
"description": "Factor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/factor": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add new factor",
"operationId": "ApiPublicInvoicesFactorPost",
"requestBody": {
"description": "Factor object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIFactor"
}
],
"description": "Factor object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycle/{cycleId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get invoice cycle by providing system-generated ID",
"operationId": "ApiPublicInvoicesCycleByCycleIdGet",
"parameters": [
{
"name": "cycleId",
"in": "path",
"description": "cycle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceCycleResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Invoices"
],
"summary": "Update invoice cycle",
"operationId": "ApiPublicInvoicesCycleByCycleIdPut",
"parameters": [
{
"name": "cycleId",
"in": "path",
"description": "invoice cycle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "invoice cycle object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycle"
}
],
"description": "Invoice cycle object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete invoice cycle (possible only when no invoices exists in this cycle)",
"operationId": "ApiPublicInvoicesCycleByCycleIdDelete",
"parameters": [
{
"name": "cycleId",
"in": "path",
"description": "cycle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycles": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all invoice's cycles",
"operationId": "ApiPublicInvoicesCyclesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceCycleResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycles/active": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all active invoice cycles",
"operationId": "ApiPublicInvoicesCyclesActiveGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceCycleResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycle": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add new invoice cycle",
"operationId": "ApiPublicInvoicesCyclePost",
"requestBody": {
"description": "Invoice cycle object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycle"
}
],
"description": "Invoice cycle object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycle/{cycleId}/terminate": {
"put": {
"tags": [
"Invoices"
],
"summary": "Terminate invoice cycle",
"operationId": "ApiPublicInvoicesCycleByCycleIdTerminatePut",
"parameters": [
{
"name": "cycleId",
"in": "path",
"description": "cycle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "terminationReason",
"in": "query",
"description": "termination reason",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycle/{cycleId}/suspend": {
"put": {
"tags": [
"Invoices"
],
"summary": "Suspend invoice cycle",
"operationId": "ApiPublicInvoicesCycleByCycleIdSuspendPut",
"parameters": [
{
"name": "cycleId",
"in": "path",
"description": "cycle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "suspendReason",
"in": "query",
"description": "suspend reason",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycle/{cycleId}/revert": {
"put": {
"tags": [
"Invoices"
],
"summary": "Revert invoice cycle (from terminated state)",
"operationId": "ApiPublicInvoicesCycleByCycleIdRevertPut",
"parameters": [
{
"name": "cycleId",
"in": "path",
"description": "cycle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/cycle/{cycleId}/activate": {
"put": {
"tags": [
"Invoices"
],
"summary": "Activate invoice cycle (from suspended state)",
"operationId": "ApiPublicInvoicesCycleByCycleIdActivatePut",
"parameters": [
{
"name": "cycleId",
"in": "path",
"description": "cycle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dateStart",
"in": "query",
"description": "date start",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "dateStop",
"in": "query",
"description": "date stop",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get invoice data by providing system-generated ID\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultOneAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Invoices"
],
"summary": "Update invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdPut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "invoice object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceChange"
}
],
"description": "Invoice object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete invoice",
"operationId": "ApiPublicInvoiceByInvoiceIdDelete",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/pdf": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get PDF file representing invoice as byte array\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdPdfGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/ksef/xml": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get KSeF XML file as byte array - only for invoices with KSeF number assigned",
"operationId": "ApiPublicInvoiceByInvoiceIdKsefXmlGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/byNumber": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get invoice data by providing invoice number\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByNumberGet",
"parameters": [
{
"name": "number",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultOneAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/downloadUrl": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get system direct URL to download/preview invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdDownloadUrlGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "language",
"in": "query",
"description": "language type: \r\n 0 - [PL] - Polish\r\n 1 - [EN] - English\r\n 2 - [DE] - Germany\r\n 3 - [RU] - Russian\r\n 4 - [CS] - Czech\r\n 5 - [FR] - French\r\n 6 - [IT] - Italy\r\n 7 - [ES] - Spain\r\n 8 - [UK] - Ukrainian\r\n 9 - [SV] - Swedish\r\n 10 - [DA] - Danish\r\n 11 - [FI] - Finnish\r\n 12 - [NB] - Norwegian\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
]
},
"x-enumNames": [
"PL",
"EN",
"DE",
"RU",
"CS",
"FR",
"IT",
"ES",
"UK",
"SV",
"DA",
"FI",
"NB",
"None"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/downloadPDF": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get system direct URL to download/preview invoice in PDF format\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdDownloadPDFGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all invoices from selected period\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoicesGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tag",
"in": "query",
"description": "filter to tag - optional",
"schema": {
"type": "string"
}
},
{
"name": "excludeProform",
"in": "query",
"description": "exclude proform in result - optional, false if missing",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/last": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all invoices for the last 31 days\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoicesLastGet",
"parameters": [
{
"name": "excludeProform",
"in": "query",
"description": "exclude proform in result - optional, false if missing",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/unpaid": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all unpaid invoices\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoicesUnpaidGet",
"parameters": [
{
"name": "proformMode",
"in": "query",
"description": "mode of inclusion of proformas in invoice request - optional, ExcludeProforma if missing \r\n 0 - [ExcludeProforma] - exclude proforma\r\n 1 - [IncludeProforma] - include proforma\r\n 2 - [OnlyProforma] - only proforma\n\n0 = ExcludeProforma\n\n1 = IncludeProforma\n\n2 = OnlyProforma",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIProformMode"
}
],
"default": 0
},
"x-enumNames": [
"ExcludeProforma",
"IncludeProforma",
"OnlyProforma"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/byContractorId/{contractorId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all not archived invoices by providing system-generated contractor ID",
"operationId": "ApiPublicInvoicesByContractorIdByContractorIdGet",
"parameters": [
{
"name": "contractorId",
"in": "path",
"description": "contractor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "excludeProform",
"in": "query",
"description": "exclude proform in result - optional, false if missing",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/byContractorTaxId/{contractorTaxId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all not archived invoices by providing contractor tax ID (or specified RecieverExternal ID)",
"operationId": "ApiPublicInvoicesByContractorTaxIdByContractorTaxIdGet",
"parameters": [
{
"name": "contractorTaxId",
"in": "path",
"description": "contractor tax id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "excludeProform",
"in": "query",
"description": "exclude proform in result - optional, false if missing",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "recieverExternalId",
"in": "query",
"description": "reciever external is - OR operator with contractorTaxId - empty if missing",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/byReceiverId/{receiverId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all not archived invoices by providing system-generated receiver ID",
"operationId": "ApiPublicInvoicesByReceiverIdByReceiverIdGet",
"parameters": [
{
"name": "receiverId",
"in": "path",
"description": "receiver id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "excludeProform",
"in": "query",
"description": "exclude proform in result - optional, false if missing",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/corrections": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all corrections for invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdCorrectionsGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/advances": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all advances for invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdAdvancesGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/related": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all invoices related to given invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdRelatedGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add new invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoicePost",
"requestBody": {
"description": "Invoice object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoice"
}
],
"description": "Invoice object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/batch": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add batch of invoices (max. 10 invoices)",
"operationId": "ApiPublicInvoiceBatchPost",
"requestBody": {
"description": "Batch of invoice objects",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoice"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIBatchResponse"
}
}
}
}
}
}
},
"/api/public/invoice/addIfNotExist": {
"post": {
"tags": [
"Invoices"
],
"summary": "Check if invoice already exists, if not add new invoice, if yes returns invoice id that already exists\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceAddIfNotExistPost",
"requestBody": {
"description": "Invoice object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoice"
}
],
"description": "Invoice object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/updateFinalized": {
"put": {
"tags": [
"Invoices"
],
"summary": "Update invoice finalized\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdUpdateFinalizedPut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "invoice object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceFinalizedChange"
}
],
"description": "Object represents the payload for changes to elements on finalized KSeF invoices"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/setAsPaid": {
"put": {
"tags": [
"Invoices"
],
"summary": "Update invoice - set as paid\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdSetAsPaidPut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "lastSettlementDate",
"in": "query",
"description": "(optional) last settlement date - current date-time if not given",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/setPaidAmount": {
"put": {
"tags": [
"Invoices"
],
"summary": "Update invoice - set paid amount for now\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdSetPaidAmountPut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "paidAmountForNow",
"in": "query",
"description": "current paid amount (not printed - for payment processing)",
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/setAsReadyToSendToKsef": {
"put": {
"tags": [
"Invoices"
],
"summary": "Update invoice - set as ready to send to KSeF (for draft invoices related to KSeF)\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdSetAsReadyToSendToKsefPut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/issueDraftInvoice": {
"put": {
"tags": [
"Invoices"
],
"summary": "Update invoice - issue draft invoice (for invoices not related to KSeF)\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdIssueDraftInvoicePut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/sendByEmail": {
"post": {
"tags": [
"Invoices"
],
"summary": "Send invoice by e-mail to a customer \r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdSendByEmailPost",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendByEmailParams"
}
],
"description": "Send by email command parameters"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendByEmailParams"
}
],
"description": "Send by email command parameters"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendByEmailParams"
}
],
"description": "Send by email command parameters"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendByEmailParams"
}
],
"description": "Send by email command parameters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/sendBySMS": {
"post": {
"tags": [
"Invoices"
],
"summary": "Send invoice by SMS to a customer",
"operationId": "ApiPublicInvoiceByInvoiceIdSendBySMSPost",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendBySMSParams"
}
],
"description": "Send by email command parameters"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendBySMSParams"
}
],
"description": "Send by email command parameters"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendBySMSParams"
}
],
"description": "Send by email command parameters"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SendBySMSParams"
}
],
"description": "Send by email command parameters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/duplicatePdf": {
"get": {
"tags": [
"Invoices"
],
"summary": "Generated PDF duplicate of an invoice with specific date",
"operationId": "ApiPublicInvoiceByInvoiceIdDuplicatePdfGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "duplicateDate",
"in": "query",
"description": "duplicate date",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/sendToKsef": {
"post": {
"tags": [
"Invoices"
],
"summary": "Sends invoice to KSeF by ID",
"operationId": "ApiPublicInvoiceByInvoiceIdSendToKsefPost",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/sendToPEF": {
"post": {
"tags": [
"Invoices"
],
"summary": "Send invoice to PEF",
"operationId": "ApiPublicInvoiceByInvoiceIdSendToPEFPost",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/correction": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add correction to invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdCorrectionPost",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Invoice object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCorrection"
}
],
"description": "Invoice correction object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/correctionToZero": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add correction to zero to invoice\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoiceByInvoiceIdCorrectionToZeroPost",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Invoice object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCorrectionToZero"
}
],
"description": "Invoice correction to zero object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/advance": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add advance to invoice",
"operationId": "ApiPublicInvoiceAdvancePost",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceAdvance"
}
],
"description": "Invoice advance object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/series/byCode": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get series invoice data by providing series code\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoicesSeriesByCodeGet",
"parameters": [
{
"name": "seriesCode",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceSeriesAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/series": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all invoice series \r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicInvoicesSeriesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceSeriesIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/external/addFile": {
"put": {
"tags": [
"Invoices"
],
"summary": "Add external attachments to invoice - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsExternalAddFilePut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of invoice attachments",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIExternalAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIExternalAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIExternalAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIExternalAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/internal/addFile": {
"put": {
"tags": [
"Invoices"
],
"summary": "Add internal attachments to invoice - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsInternalAddFilePut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of invoice internal attachments",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/internal/addURL": {
"put": {
"tags": [
"Invoices"
],
"summary": "Add internal url attachments to invoice - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsInternalAddURLPut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of url attachments",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/internal/addRelated": {
"put": {
"tags": [
"Invoices"
],
"summary": "Add internal related attachments to invoice - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsInternalAddRelatedPut",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of attachments related to invoice",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/internal": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get internal attachments for invoice - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsInternalGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInternalAttachmentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/external": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get external attachments for invoice - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsExternalGet",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIExternalAttachmentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/internal/{internalAttachmentId}": {
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete invoice internal attachment - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsInternalByInternalAttachmentIdDelete",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "internalAttachmentId",
"in": "path",
"description": "internal attachment id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoice/{invoiceId}/attachments/external/{externalAttachmentId}": {
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete invoice external attachment - only for Power or higher accounts level",
"operationId": "ApiPublicInvoiceByInvoiceIdAttachmentsExternalByExternalAttachmentIdDelete",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"description": "invoice id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "externalAttachmentId",
"in": "path",
"description": "external attachment id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/product/{productId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get product data by providing system-generated ID",
"operationId": "ApiPublicInvoicesProductByProductIdGet",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "Product id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Invoices"
],
"summary": "Update product",
"operationId": "ApiPublicInvoicesProductByProductIdPut",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "Product id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Product object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIProduct"
}
],
"description": "Product"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete product",
"operationId": "ApiPublicInvoicesProductByProductIdDelete",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "Product id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/product/byName": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get product data by providing product name",
"operationId": "ApiPublicInvoicesProductByNameGet",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Product name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/products/search": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get products data by providing text to search. The search is performed by the product name.",
"operationId": "ApiPublicInvoicesProductsSearchGet",
"parameters": [
{
"name": "searchText",
"in": "query",
"description": "Text to search",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of results - optional, 50 if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/products/last": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get last products data by providing invoice series",
"operationId": "ApiPublicInvoicesProductsLastGet",
"parameters": [
{
"name": "seriesCode",
"in": "query",
"description": "Code of invoice series - optional, default series if missing, * if all series",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of last products - optional, 10 if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "alreadyUsedProducts",
"in": "query",
"description": "List of used products (product id - system generated), to be excluded from the search",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/products": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all products",
"operationId": "ApiPublicInvoicesProductsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/products/lastSets": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get last products sets",
"operationId": "ApiPublicInvoicesProductsLastSetsGet",
"parameters": [
{
"name": "contractorId",
"in": "query",
"description": "Contractor ID (system generated) - optional,try to get from contractorIdentifier if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contractorIdentifier",
"in": "query",
"description": "Contractor identifier - optional, try to get from contractorId if missing",
"schema": {
"type": "string"
}
},
{
"name": "seriesCode",
"in": "query",
"description": "Code of invoice series - optional, default series if missing, * if all series",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of last products sets - optional, 6 if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductSetsAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/product": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add new product",
"operationId": "ApiPublicInvoicesProductPost",
"requestBody": {
"description": "Product object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIProduct"
}
],
"description": "Product"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/receiver/{receiverId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get receiver data by providing system-generated ID",
"operationId": "ApiPublicInvoicesReceiverByReceiverIdGet",
"parameters": [
{
"name": "receiverId",
"in": "path",
"description": "Receiver id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIReceiverResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Invoices"
],
"summary": "Update receiver",
"operationId": "ApiPublicInvoicesReceiverByReceiverIdPut",
"parameters": [
{
"name": "receiverId",
"in": "path",
"description": "Receiver id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Receiver object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIReceiver"
}
],
"description": "Receiver object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Invoices"
],
"summary": "Delete receiver",
"operationId": "ApiPublicInvoicesReceiverByReceiverIdDelete",
"parameters": [
{
"name": "receiverId",
"in": "path",
"description": "Receiver id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/invoices/receivers": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all receivers",
"operationId": "ApiPublicInvoicesReceiversGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIReceiverResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/receivers/byContractorId/{contractorId}": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get all receivers by providing system-generated ID contractor",
"operationId": "ApiPublicInvoicesReceiversByContractorIdByContractorIdGet",
"parameters": [
{
"name": "contractorId",
"in": "path",
"description": "Contractor id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIReceiverResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/invoices/receiver": {
"post": {
"tags": [
"Invoices"
],
"summary": "Add new receiver",
"operationId": "ApiPublicInvoicesReceiverPost",
"requestBody": {
"description": "Receiver object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIReceiver"
}
],
"description": "Receiver object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/treasuries": {
"get": {
"tags": [
"Treasuries"
],
"summary": "Get all treasuries",
"operationId": "ApiPublicTreasuriesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITreasuryIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/treasury/{treasuryId}": {
"get": {
"tags": [
"Treasuries"
],
"summary": "Get treasury by providing system-generated ID",
"operationId": "ApiPublicTreasuryByTreasuryIdGet",
"parameters": [
{
"name": "treasuryId",
"in": "path",
"description": "treasury id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITreasuryAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/treasuries/documents": {
"get": {
"tags": [
"Treasuries"
],
"summary": "Get all cash documents",
"operationId": "ApiPublicTreasuriesDocumentsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICashDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/treasury/{treasuryId}/documents": {
"get": {
"tags": [
"Treasuries"
],
"summary": "Get all cash documents for treasury by providing system-generated treasury ID",
"operationId": "ApiPublicTreasuryByTreasuryIdDocumentsGet",
"parameters": [
{
"name": "treasuryId",
"in": "path",
"description": "treasury id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICashDocumentResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/treasuries/document/{documentId}": {
"get": {
"tags": [
"Treasuries"
],
"summary": "Get cash document by providing system-generated ID",
"operationId": "ApiPublicTreasuriesDocumentByDocumentIdGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "cash document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICashDocumentResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Treasuries"
],
"summary": "Update cash document",
"operationId": "ApiPublicTreasuriesDocumentByDocumentIdPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "cash document object",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocumentChange"
}
],
"description": "Cash document change object"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocumentChange"
}
],
"description": "Cash document change object"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocumentChange"
}
],
"description": "Cash document change object"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocumentChange"
}
],
"description": "Cash document change object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Treasuries"
],
"summary": "Delete cash document",
"operationId": "ApiPublicTreasuriesDocumentByDocumentIdDelete",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "cash document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/treasuries/document/byNumber": {
"get": {
"tags": [
"Treasuries"
],
"summary": "Get cash document by number",
"operationId": "ApiPublicTreasuriesDocumentByNumberGet",
"parameters": [
{
"name": "number",
"in": "query",
"description": "cash document number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICashDocumentResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/treasuries/document/{documentId}/pdf": {
"get": {
"tags": [
"Treasuries"
],
"summary": "Get PDF file representing cash document as byte array",
"operationId": "ApiPublicTreasuriesDocumentByDocumentIdPdfGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "cash document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/treasuries/document": {
"post": {
"tags": [
"Treasuries"
],
"summary": "Add cash document to provided treasury",
"operationId": "ApiPublicTreasuriesDocumentPost",
"requestBody": {
"description": "cash document object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocument"
}
],
"description": "Cash document object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tag/{tagId}": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get tag data by providing system-generated ID",
"operationId": "ApiPublicTagByTagIdGet",
"parameters": [
{
"name": "tagId",
"in": "path",
"description": "tag id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITagResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Tags and Allocations"
],
"summary": "Update tag",
"operationId": "ApiPublicTagByTagIdPut",
"parameters": [
{
"name": "tagId",
"in": "path",
"description": "tag id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "tag object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APITag"
}
],
"description": "Tag object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Tags and Allocations"
],
"summary": "Delete tag",
"operationId": "ApiPublicTagByTagIdDelete",
"parameters": [
{
"name": "tagId",
"in": "path",
"description": "tag id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/tag/byName": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get tag data by providing tag name",
"operationId": "ApiPublicTagByNameGet",
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITagResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tags": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get all tags or get all tags from group",
"operationId": "ApiPublicTagsGet",
"parameters": [
{
"name": "tagGroupName",
"in": "query",
"description": "tagGroupName - optional, tagGroupId if missing",
"schema": {
"type": "string"
}
},
{
"name": "tagGroupId",
"in": "query",
"description": "tagGroupId - optional, all tags if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITagResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tags/allocation": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get allocation result from selected period",
"operationId": "ApiPublicTagsAllocationGet",
"parameters": [
{
"name": "tags",
"in": "query",
"description": "tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "onlyThisTags",
"in": "query",
"description": "narrow your search to these tags only - optional, false if missing",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAllocationResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tags/manualRecords": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get all manual recrod for e-Projects",
"operationId": "ApiPublicTagsManualRecordsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIManualRecordResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tags/allocationKeys": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get all allocation keys - only for Ultra+ accounts level",
"operationId": "ApiPublicTagsAllocationKeysGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAllocationKeyResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tags/allocationKey/{allocationKeyId}": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get allocation key data by providing system-generated ID - only for Ultra+ accounts level",
"operationId": "ApiPublicTagsAllocationKeyByAllocationKeyIdGet",
"parameters": [
{
"name": "allocationKeyId",
"in": "path",
"description": "allocation key id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAllocationKeyResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Tags and Allocations"
],
"summary": "Update allocation key - only for Ultra+ accounts level",
"operationId": "ApiPublicTagsAllocationKeyByAllocationKeyIdPut",
"parameters": [
{
"name": "allocationKeyId",
"in": "path",
"description": "allocation key id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "allocation key object",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Tags and Allocations"
],
"summary": "Delete allocation key - only for Ultra+ accounts level",
"operationId": "ApiPublicTagsAllocationKeyByAllocationKeyIdDelete",
"parameters": [
{
"name": "allocationKeyId",
"in": "path",
"description": "allocation key id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/tag": {
"post": {
"tags": [
"Tags and Allocations"
],
"summary": "Add new tag",
"operationId": "ApiPublicTagPost",
"requestBody": {
"description": "Tag object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APITag"
}
],
"description": "Tag object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tags/manualRecord": {
"post": {
"tags": [
"Tags and Allocations"
],
"summary": "Add manual record for e-Project",
"operationId": "ApiPublicTagsManualRecordPost",
"requestBody": {
"description": "manual record object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIManualRecord"
}
],
"description": "Manual record object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/tags/manualRecord/{manulRecordId}": {
"put": {
"tags": [
"Tags and Allocations"
],
"summary": "Update manual record for e-Project item",
"operationId": "ApiPublicTagsManualRecordByManulRecordIdPut",
"parameters": [
{
"name": "manulRecordId",
"in": "path",
"description": "manual record id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "manual record object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIManualRecord"
}
],
"description": "Manual record object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Tags and Allocations"
],
"summary": "Delete manual record for e-Project item",
"operationId": "ApiPublicTagsManualRecordByManulRecordIdDelete",
"parameters": [
{
"name": "manulRecordId",
"in": "path",
"description": "manual record id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/tags/allocationKey": {
"post": {
"tags": [
"Tags and Allocations"
],
"summary": "Add allocation key - only for Ultra+ accounts level",
"operationId": "ApiPublicTagsAllocationKeyPost",
"requestBody": {
"description": "allocation key object",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKey"
}
],
"description": "Allocation key object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/tagGroup/{tagGroupId}": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get tag group data by providing system-generated ID",
"operationId": "ApiPublicTagGroupByTagGroupIdGet",
"parameters": [
{
"name": "tagGroupId",
"in": "path",
"description": "tag group id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITagGroupResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/tagGroups": {
"get": {
"tags": [
"Tags and Allocations"
],
"summary": "Get all tag groups",
"operationId": "ApiPublicTagGroupsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITagGroupResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/accountDescription": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get account description by providing account",
"operationId": "ApiPublicAccountingDataAccountDescriptionGet",
"parameters": [
{
"name": "accountNumber",
"in": "query",
"description": "Account number",
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"description": "Year - optional, accounting year id or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountingYearId",
"in": "query",
"description": "Accounting year id - optional, try to get from year or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/accountValues": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get account value by months by providing account",
"operationId": "ApiPublicAccountingDataAccountValuesGet",
"parameters": [
{
"name": "financialFunction",
"in": "query",
"description": "Accounting financial function:\r\n 1 - [Debit] - Debit\r\n 2 - [Credit] - Credit\r\n 3 - [DebitYTD] - Debit year to date\r\n 4 - [CreditYTD] - Credit year to date\r\n 5 - [BalanceDebit] - Balance debit\r\n 6 - [BalanceCredit] - Balance credit\r\n 7 - [BalanceDebitYTD] - Balance debit year to date\r\n 8 - [BalanceCreditYTD] - Balance credit year to date\r\n 9 - [PerBalanceDebit] - Per balance debit\r\n 10 - [PerBalanceCredit] - Per balance credit\r\n 11 - [PerBalanceDebitYTD] - Pre balance debit year to date\r\n 12 - [PerBalanceCreditYTD] - Pre balance credit year to date\r\n 13 - [OpeningDebit] - Opening balance debit\r\n 14 - [OpeningCredit] - Opening balance credit\r\n 15 - [OpeningBalanceDebit] - Opening balance debit\r\n 16 - [OpeningBalanceCredit] - Opening balance credit\n\n1 = Debit\n\n2 = Credit\n\n3 = DebitYTD\n\n4 = CreditYTD\n\n5 = BalanceDebit\n\n6 = BalanceCredit\n\n7 = BalanceDebitYTD\n\n8 = BalanceCreditYTD\n\n9 = PerBalanceDebit\n\n10 = PerBalanceCredit\n\n11 = PerBalanceDebitYTD\n\n12 = PerBalanceCreditYTD\n\n13 = OpeningDebit\n\n14 = OpeningCredit\n\n15 = OpeningBalanceDebit\n\n16 = OpeningBalanceCredit",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAccountingFinancialFunction"
}
],
"description": " Accounting financial function:\r\n\r\n1 - [Debit] - Debit\r\n2 - [Credit] - Credit\r\n3 - [DebitYTD] - Debit year to date\r\n4 - [CreditYTD] - Credit year to date\r\n5 - [BalanceDebit] - Balance debit\r\n6 - [BalanceCredit] - Balance credit\r\n7 - [BalanceDebitYTD] - Balance debit year to date\r\n8 - [BalanceCreditYTD] - Balance credit year to date\r\n9 - [PerBalanceDebit] - Per balance debit\r\n10 - [PerBalanceCredit] - Per balance credit\r\n11 - [PerBalanceDebitYTD] - Pre balance debit year to date\r\n12 - [PerBalanceCreditYTD] - Pre balance credit year to date\r\n13 - [OpeningDebit] - Opening balance debit\r\n14 - [OpeningCredit] - Opening balance credit\r\n15 - [OpeningBalanceDebit] - Opening balance debit\r\n16 - [OpeningBalanceCredit] - Opening balance credit",
"x-enumNames": [
"Debit",
"Credit",
"DebitYTD",
"CreditYTD",
"BalanceDebit",
"BalanceCredit",
"BalanceDebitYTD",
"BalanceCreditYTD",
"PerBalanceDebit",
"PerBalanceCredit",
"PerBalanceDebitYTD",
"PerBalanceCreditYTD",
"OpeningDebit",
"OpeningCredit",
"OpeningBalanceDebit",
"OpeningBalanceCredit"
]
},
"x-enumNames": [
"Debit",
"Credit",
"DebitYTD",
"CreditYTD",
"BalanceDebit",
"BalanceCredit",
"BalanceDebitYTD",
"BalanceCreditYTD",
"PerBalanceDebit",
"PerBalanceCredit",
"PerBalanceDebitYTD",
"PerBalanceCreditYTD",
"OpeningDebit",
"OpeningCredit",
"OpeningBalanceDebit",
"OpeningBalanceCredit"
]
},
{
"name": "accountNumber",
"in": "query",
"description": "Account number",
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"description": "Year - optional, accounting year id or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountingYearId",
"in": "query",
"description": "Accounting year id - optional, try to get from year or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAccountValueIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/accountValueByMonth": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get account value by providing account and month",
"operationId": "ApiPublicAccountingDataAccountValueByMonthGet",
"parameters": [
{
"name": "financialFunction",
"in": "query",
"description": "Accounting financial function:\r\n 1 - [Debit] - Debit\r\n 2 - [Credit] - Credit\r\n 3 - [DebitYTD] - Debit year to date\r\n 4 - [CreditYTD] - Credit year to date\r\n 5 - [BalanceDebit] - Balance debit\r\n 6 - [BalanceCredit] - Balance credit\r\n 7 - [BalanceDebitYTD] - Balance debit year to date\r\n 8 - [BalanceCreditYTD] - Balance credit year to date\r\n 9 - [PerBalanceDebit] - Per balance debit\r\n 10 - [PerBalanceCredit] - Per balance credit\r\n 11 - [PerBalanceDebitYTD] - Pre balance debit year to date\r\n 12 - [PerBalanceCreditYTD] - Pre balance credit year to date\r\n 13 - [OpeningDebit] - Opening balance debit\r\n 14 - [OpeningCredit] - Opening balance credit\r\n 15 - [OpeningBalanceDebit] - Opening balance debit\r\n 16 - [OpeningBalanceCredit] - Opening balance credit\n\n1 = Debit\n\n2 = Credit\n\n3 = DebitYTD\n\n4 = CreditYTD\n\n5 = BalanceDebit\n\n6 = BalanceCredit\n\n7 = BalanceDebitYTD\n\n8 = BalanceCreditYTD\n\n9 = PerBalanceDebit\n\n10 = PerBalanceCredit\n\n11 = PerBalanceDebitYTD\n\n12 = PerBalanceCreditYTD\n\n13 = OpeningDebit\n\n14 = OpeningCredit\n\n15 = OpeningBalanceDebit\n\n16 = OpeningBalanceCredit",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAccountingFinancialFunction"
}
],
"description": " Accounting financial function:\r\n\r\n1 - [Debit] - Debit\r\n2 - [Credit] - Credit\r\n3 - [DebitYTD] - Debit year to date\r\n4 - [CreditYTD] - Credit year to date\r\n5 - [BalanceDebit] - Balance debit\r\n6 - [BalanceCredit] - Balance credit\r\n7 - [BalanceDebitYTD] - Balance debit year to date\r\n8 - [BalanceCreditYTD] - Balance credit year to date\r\n9 - [PerBalanceDebit] - Per balance debit\r\n10 - [PerBalanceCredit] - Per balance credit\r\n11 - [PerBalanceDebitYTD] - Pre balance debit year to date\r\n12 - [PerBalanceCreditYTD] - Pre balance credit year to date\r\n13 - [OpeningDebit] - Opening balance debit\r\n14 - [OpeningCredit] - Opening balance credit\r\n15 - [OpeningBalanceDebit] - Opening balance debit\r\n16 - [OpeningBalanceCredit] - Opening balance credit",
"x-enumNames": [
"Debit",
"Credit",
"DebitYTD",
"CreditYTD",
"BalanceDebit",
"BalanceCredit",
"BalanceDebitYTD",
"BalanceCreditYTD",
"PerBalanceDebit",
"PerBalanceCredit",
"PerBalanceDebitYTD",
"PerBalanceCreditYTD",
"OpeningDebit",
"OpeningCredit",
"OpeningBalanceDebit",
"OpeningBalanceCredit"
]
},
"x-enumNames": [
"Debit",
"Credit",
"DebitYTD",
"CreditYTD",
"BalanceDebit",
"BalanceCredit",
"BalanceDebitYTD",
"BalanceCreditYTD",
"PerBalanceDebit",
"PerBalanceCredit",
"PerBalanceDebitYTD",
"PerBalanceCreditYTD",
"OpeningDebit",
"OpeningCredit",
"OpeningBalanceDebit",
"OpeningBalanceCredit"
]
},
{
"name": "accountNumber",
"in": "query",
"description": "Account number",
"schema": {
"type": "string"
}
},
{
"name": "month",
"in": "query",
"description": "Month",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "year",
"in": "query",
"description": "Year - optional, accounting year id or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountingYearId",
"in": "query",
"description": "Accounting year id - optional, try to get from year or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DecimalNullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/batch/accountValueByMonth": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Batch get account value by providing account and month",
"operationId": "ApiPublicAccountingDataBatchAccountValueByMonthGet",
"parameters": [
{
"name": "toExecute",
"in": "query",
"description": "list of get account value to execute",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIBatchAccountValueParams"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DecimalNullableAPIBatchExecutionResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/chartOfAccount": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get chart of account",
"operationId": "ApiPublicAccountingDataChartOfAccountGet",
"parameters": [
{
"name": "accountingYearId",
"in": "query",
"description": "Accounting year id - optional, current if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIChartOfAccountAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/chartOfAccount/byNumber": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Find chart of account by providing account number",
"operationId": "ApiPublicAccountingDataChartOfAccountByNumberGet",
"parameters": [
{
"name": "accountNumber",
"in": "query",
"description": "Account number",
"schema": {
"type": "string"
}
},
{
"name": "accountingYearId",
"in": "query",
"description": "Accounting year id - optional, current if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIChartOfAccountAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/dictionary/{dictionaryId}": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get dictionary chart of accounts by providing dictionary system-generated Id",
"operationId": "ApiPublicAccountingDataDictionaryByDictionaryIdGet",
"parameters": [
{
"name": "dictionaryId",
"in": "path",
"description": "Dictionary Id (system-generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAccDictionaryAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/accountingYears": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get all accounting years",
"operationId": "ApiPublicAccountingDataAccountingYearsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAccountingYearIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/integrationStatus": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get integration status",
"operationId": "ApiPublicAccountingDataIntegrationStatusGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIIntegrationParameterAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/documents": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get account documents - only for Ultimate accounts level",
"operationId": "ApiPublicAccountingDataDocumentsGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAccountingDocumentIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/accountingData/records": {
"get": {
"tags": [
"Accounting Data"
],
"summary": "Get account records - only for Ultimate accounts level",
"operationId": "ApiPublicAccountingDataRecordsGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "Year - optional, accounting year id or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountingYearId",
"in": "query",
"description": "Accounting year id - optional, try to get from year or current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountNumber",
"in": "query",
"description": "Account number or beginning of account number- optional, all if missing",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAccountingRecordIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/individualReports": {
"get": {
"tags": [
"Individual Reports"
],
"summary": "Get all individual reports",
"operationId": "ApiPublicIndividualReportsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIIndividualReportResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/individualReport/{individualReportId}": {
"get": {
"tags": [
"Individual Reports"
],
"summary": "Get individual report data by providing system-generated ID",
"operationId": "ApiPublicIndividualReportByIndividualReportIdGet",
"parameters": [
{
"name": "individualReportId",
"in": "path",
"description": "individual report id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIIndividualReportResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Individual Reports"
],
"summary": "Update individual report",
"operationId": "ApiPublicIndividualReportByIndividualReportIdPut",
"parameters": [
{
"name": "individualReportId",
"in": "path",
"description": "individual report id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "individual report object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIndividualReport"
}
],
"description": "Individual report object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Individual Reports"
],
"summary": "Delete individual report",
"operationId": "ApiPublicIndividualReportByIndividualReportIdDelete",
"parameters": [
{
"name": "individualReportId",
"in": "path",
"description": "individual report id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/individualReport/{individualReportId}/file": {
"get": {
"tags": [
"Individual Reports"
],
"summary": "Get file representing individual report as byte array",
"operationId": "ApiPublicIndividualReportByIndividualReportIdFileGet",
"parameters": [
{
"name": "individualReportId",
"in": "path",
"description": "individual report id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/individualReport": {
"post": {
"tags": [
"Individual Reports"
],
"summary": "Add new individual report",
"operationId": "ApiPublicIndividualReportPost",
"requestBody": {
"description": "Individual report object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIndividualReport"
}
],
"description": "Individual report object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/reportTemplates/excelTemplates": {
"get": {
"tags": [
"Individual Reports"
],
"summary": "Get excel templates",
"operationId": "ApiPublicReportTemplatesExcelTemplatesGet",
"parameters": [
{
"name": "culture",
"in": "query",
"description": "Culture (language) - optional, default culture if missing",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIExcelReportTemplateIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/reportTemplates/excelTemplate/{fileId}": {
"get": {
"tags": [
"Individual Reports"
],
"summary": "Get excel template file by providing dictionary system-generated Id",
"operationId": "ApiPublicReportTemplatesExcelTemplateByFileIdGet",
"parameters": [
{
"name": "fileId",
"in": "path",
"description": "File Id (system-generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/taxes": {
"get": {
"tags": [
"Taxes"
],
"summary": "Get all taxes from selected period",
"operationId": "ApiPublicTaxesGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITaxResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/taxes/unpaid": {
"get": {
"tags": [
"Taxes"
],
"summary": "Get all unpaid taxes",
"operationId": "ApiPublicTaxesUnpaidGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITaxResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/taxes/{taxId}": {
"get": {
"tags": [
"Taxes"
],
"summary": "Get tax data by providing system-generated ID",
"operationId": "ApiPublicTaxesByTaxIdGet",
"parameters": [
{
"name": "taxId",
"in": "path",
"description": "tax ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITaxResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/taxes/{taxId}/setAsPaid": {
"put": {
"tags": [
"Taxes"
],
"summary": "Mark tax as paid",
"operationId": "ApiPublicTaxesByTaxIdSetAsPaidPut",
"parameters": [
{
"name": "taxId",
"in": "path",
"description": "tax ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/timesheet/{timesheetId}": {
"get": {
"tags": [
"Timesheets"
],
"summary": "Get timesheet data by providing system-generated ID",
"operationId": "ApiPublicTimesheetByTimesheetIdGet",
"parameters": [
{
"name": "timesheetId",
"in": "path",
"description": "timesheet id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITimesheetResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Timesheets"
],
"summary": "Update timesheet item",
"operationId": "ApiPublicTimesheetByTimesheetIdPut",
"parameters": [
{
"name": "timesheetId",
"in": "path",
"description": "timesheet id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "timesheet object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APITimesheet"
}
],
"description": "Timesheet object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Timesheets"
],
"summary": "Delete timesheet item",
"operationId": "ApiPublicTimesheetByTimesheetIdDelete",
"parameters": [
{
"name": "timesheetId",
"in": "path",
"description": "timesheet id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/timesheets": {
"get": {
"tags": [
"Timesheets"
],
"summary": "Get all timesheets from selected period",
"operationId": "ApiPublicTimesheetsGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tag",
"in": "query",
"description": "filter to tag - optional",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APITimesheetResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/timesheet": {
"post": {
"tags": [
"Timesheets"
],
"summary": "Add new timesheet item",
"operationId": "ApiPublicTimesheetPost",
"requestBody": {
"description": "Timesheet object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APITimesheet"
}
],
"description": "Timesheet object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/productsUnits": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all product units",
"operationId": "ApiPublicDictionariesProductsUnitsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductUnitIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/VATRates": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all VAT rates",
"operationId": "ApiPublicDictionariesVATRatesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIVATRateIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/productVATCodes": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all goverment VAT Code assigned to product",
"operationId": "ApiPublicDictionariesProductVATCodesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIProductVATCodeIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/productVATProcedures": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all VAT procedures",
"operationId": "ApiPublicDictionariesProductVATProceduresGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIVATProceduresIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/paymentForms": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all payment forms",
"operationId": "ApiPublicDictionariesPaymentFormsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDictionaryPaymentFormIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/paymentEventTypes": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all payment event types",
"operationId": "ApiPublicDictionariesPaymentEventTypesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDictionaryPaymentEventTypeIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/paymentDays": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all days from the event triggering the payment of invoice",
"operationId": "ApiPublicDictionariesPaymentDaysGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIPaymentEventDayIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/numberPostscripts": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all special postscripts to invoice number",
"operationId": "ApiPublicDictionariesNumberPostscriptsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APINumberPostscriptIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/dictionaries/countries": {
"get": {
"tags": [
"Dictionaries"
],
"summary": "Get all countries",
"operationId": "ApiPublicDictionariesCountriesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICountryIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/bankAccount/{bankAccountId}": {
"get": {
"tags": [
"Bank"
],
"summary": "Get bank account data for invoice by providing system-generated ID",
"operationId": "ApiPublicBankBankAccountByBankAccountIdGet",
"parameters": [
{
"name": "bankAccountId",
"in": "path",
"description": "bank account id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBankAccountResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/bankAccount/{bankAccountId}/withBalance": {
"get": {
"tags": [
"Bank"
],
"summary": "Get bank account data for invoice with balance by providing system-generated ID - only for Ultra+ accounts level",
"operationId": "ApiPublicBankBankAccountByBankAccountIdWithBalanceGet",
"parameters": [
{
"name": "bankAccountId",
"in": "path",
"description": "bank account id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBankAccountWithBalanceResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/bankAccounts": {
"get": {
"tags": [
"Bank"
],
"summary": "Get all bank accounts for invoice",
"operationId": "ApiPublicBankBankAccountsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBankAccountResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/bankAccounts/withBalance": {
"get": {
"tags": [
"Bank"
],
"summary": "Get all bank accounts for invoice with balance - only for Ultra+ accounts level",
"operationId": "ApiPublicBankBankAccountsWithBalanceGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBankAccountWithBalanceResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/transactions/in": {
"get": {
"tags": [
"Bank"
],
"summary": "Get all in bank transactions - only for Ultra+ accounts level",
"operationId": "ApiPublicBankTransactionsInGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "lastNMonths",
"in": "query",
"description": "lastNMonths - optional, max last 12 months, overwrites year and month parameter",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBankTransactionResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/transactions/out": {
"get": {
"tags": [
"Bank"
],
"summary": "Get all out bank transactions - only for Ultra+ accounts level",
"operationId": "ApiPublicBankTransactionsOutGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "lastNMonths",
"in": "query",
"description": "lastNMonths - optional, max last 12 months, overwrites year and month parameter",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBankTransactionResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/transactions/other": {
"get": {
"tags": [
"Bank"
],
"summary": "Get all other bank transactions - only for Ultra+ accounts level",
"operationId": "ApiPublicBankTransactionsOtherGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "lastNMonths",
"in": "query",
"description": "lastNMonths - optional, max last 12 months, overwrites year and month parameter",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIBankTransactionResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/bank/transactions/{transactionId}": {
"put": {
"tags": [
"Bank"
],
"summary": "Update bank transaction item - only for Ultra+ accounts level",
"operationId": "ApiPublicBankTransactionsByTransactionIdPut",
"parameters": [
{
"name": "transactionId",
"in": "path",
"description": "bank transaction id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "bank transaction object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIBankTransaction"
}
],
"description": "Bank transaction"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequest/{absenceId}": {
"get": {
"tags": [
"Personnel"
],
"summary": "Get absence request by providing system-generated ID",
"operationId": "ApiPublicAbsenceRequestByAbsenceIdGet",
"parameters": [
{
"name": "absenceId",
"in": "path",
"description": "absence id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAbsenceRequestResultOneAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequests": {
"get": {
"tags": [
"Personnel"
],
"summary": "Get all absence requests",
"operationId": "ApiPublicAbsenceRequestsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAbsenceRequestResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequests/myRequests": {
"get": {
"tags": [
"Personnel"
],
"summary": "Get all for user",
"operationId": "ApiPublicAbsenceRequestsMyRequestsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAbsenceRequestResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequests/toAccept": {
"get": {
"tags": [
"Personnel"
],
"summary": "Get all to accept",
"operationId": "ApiPublicAbsenceRequestsToAcceptGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAbsenceRequestResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequests/accepted": {
"get": {
"tags": [
"Personnel"
],
"summary": "Get all accepted",
"operationId": "ApiPublicAbsenceRequestsAcceptedGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIAbsenceRequestResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequest": {
"post": {
"tags": [
"Personnel"
],
"summary": "Add new absence request item",
"operationId": "ApiPublicAbsenceRequestPost",
"requestBody": {
"description": "AbsenceRequest object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIAbsenceRequestBase"
}
],
"description": "Absence Request object [base]"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequest/{absenceRequestId}/accept": {
"put": {
"tags": [
"Personnel"
],
"summary": "Accept by id",
"operationId": "ApiPublicAbsenceRequestByAbsenceRequestIdAcceptPut",
"parameters": [
{
"name": "absenceRequestId",
"in": "path",
"description": "absence id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userLogin",
"in": "query",
"description": "Login of the user accepting absence request. (Required when logging in is not done using a login and password)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequest/{absenceRequestId}/reject": {
"put": {
"tags": [
"Personnel"
],
"summary": "Reject by id",
"operationId": "ApiPublicAbsenceRequestByAbsenceRequestIdRejectPut",
"parameters": [
{
"name": "absenceRequestId",
"in": "path",
"description": "absence id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userLogin",
"in": "query",
"description": "Login of the user rejecting absence request. (Required when logging in is not done using a login and password)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/absenceRequest/{absenceRequestId}/withdraw": {
"put": {
"tags": [
"Personnel"
],
"summary": "Withdraw by id",
"operationId": "ApiPublicAbsenceRequestByAbsenceRequestIdWithdrawPut",
"parameters": [
{
"name": "absenceRequestId",
"in": "path",
"description": "absence id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userLogin",
"in": "query",
"description": "Login of the user withdrawing absence request. (Required when logging in is not done using a login and password)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}": {
"get": {
"tags": [
"Interest Notes"
],
"summary": "Get interest note data by providing system-generated ID",
"operationId": "ApiPublicInterestNoteByInterestNoteIdGet",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInterestNoteResultOneAPIDataResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Interest Notes"
],
"summary": "Delete interest note",
"operationId": "ApiPublicInterestNoteByInterestNoteIdDelete",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}/pdf": {
"get": {
"tags": [
"Interest Notes"
],
"summary": "Get PDF file representing interest note as byte array",
"operationId": "ApiPublicInterestNoteByInterestNoteIdPdfGet",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}/downloadUrl": {
"get": {
"tags": [
"Interest Notes"
],
"summary": "Get system direct URL to download/preview interest note",
"operationId": "ApiPublicInterestNoteByInterestNoteIdDownloadUrlGet",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/interestNotes": {
"get": {
"tags": [
"Interest Notes"
],
"summary": "Get all interest notes from selected period",
"operationId": "ApiPublicInterestNotesGet",
"parameters": [
{
"name": "year",
"in": "query",
"description": "year - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "month",
"in": "query",
"description": "month - optional, whole year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tag",
"in": "query",
"description": "filter to tag - optional",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInterestNoteResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/interestNote": {
"post": {
"tags": [
"Interest Notes"
],
"summary": "Add new interest note",
"operationId": "ApiPublicInterestNotePost",
"requestBody": {
"description": "interest note object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIInterestNote"
}
],
"description": "Interest Note object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}/setAsPaid": {
"put": {
"tags": [
"Interest Notes"
],
"summary": "Update interest note - set as paid",
"operationId": "ApiPublicInterestNoteByInterestNoteIdSetAsPaidPut",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "lastSettlementDate",
"in": "query",
"description": "(optional) last settlement date - current date-time if not given",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}/setAsNotPaid": {
"put": {
"tags": [
"Interest Notes"
],
"summary": "Update interest note - set as not paid",
"operationId": "ApiPublicInterestNoteByInterestNoteIdSetAsNotPaidPut",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}/setPaidAmount": {
"put": {
"tags": [
"Interest Notes"
],
"summary": "Update interest note - set paid amount for now",
"operationId": "ApiPublicInterestNoteByInterestNoteIdSetPaidAmountPut",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "paidAmountForNow",
"in": "query",
"description": "current paid amount (not printed - for payment processing)",
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}/setAsCanceled": {
"put": {
"tags": [
"Interest Notes"
],
"summary": "Update interest note - set as canceled",
"operationId": "ApiPublicInterestNoteByInterestNoteIdSetAsCanceledPut",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "statusChangeDescription",
"in": "query",
"description": "description of the reason for canceling",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/interestNote/{interestNoteId}/sendByEmail": {
"post": {
"tags": [
"Interest Notes"
],
"summary": "Send interest note by e-mail to a customer",
"operationId": "ApiPublicInterestNoteByInterestNoteIdSendByEmailPost",
"parameters": [
{
"name": "interestNoteId",
"in": "path",
"description": "interest note id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteSendByEmailParams"
}
],
"description": "Send by email command parameters"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteSendByEmailParams"
}
],
"description": "Send by email command parameters"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteSendByEmailParams"
}
],
"description": "Send by email command parameters"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteSendByEmailParams"
}
],
"description": "Send by email command parameters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/issue/{issueId}": {
"get": {
"tags": [
"Issues"
],
"summary": "Get issue by providing system-generated ID",
"operationId": "ApiPublicIssueByIssueIdGet",
"parameters": [
{
"name": "issueId",
"in": "path",
"description": "issue id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIIssueResultOneAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Issues"
],
"summary": "Update issue",
"operationId": "ApiPublicIssueByIssueIdPut",
"parameters": [
{
"name": "issueId",
"in": "path",
"description": "issue id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "issue object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueChange"
}
],
"description": "Issue object for change"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/issues": {
"get": {
"tags": [
"Issues"
],
"summary": "Get all issues",
"operationId": "ApiPublicIssuesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIIssueResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/issues/open": {
"get": {
"tags": [
"Issues"
],
"summary": "Get all open issues",
"operationId": "ApiPublicIssuesOpenGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIIssueResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/issues/assignedForUser": {
"get": {
"tags": [
"Issues"
],
"summary": "Get all issues that are assigned for user",
"operationId": "ApiPublicIssuesAssignedForUserGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIIssueResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/issue": {
"post": {
"tags": [
"Issues"
],
"summary": "Add new issue",
"operationId": "ApiPublicIssuePost",
"requestBody": {
"description": "Issue object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssue"
}
],
"description": "Issue object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/issue/{issueId}/setAsClose": {
"put": {
"tags": [
"Issues"
],
"summary": "Update issue - set as close",
"operationId": "ApiPublicIssueByIssueIdSetAsClosePut",
"parameters": [
{
"name": "issueId",
"in": "path",
"description": "issue id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userLogin",
"in": "query",
"description": "Login of the user adding responses to the issue. (Required when logging in is not done using a login and password)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/issue/{issueId}/setAsRead": {
"put": {
"tags": [
"Issues"
],
"summary": "Update issue - set as read",
"operationId": "ApiPublicIssueByIssueIdSetAsReadPut",
"parameters": [
{
"name": "issueId",
"in": "path",
"description": "issue id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userLogin",
"in": "query",
"description": "Login of the user adding responses to the issue. (Required when logging in is not done using a login and password)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/issue/{issueId}/addResponse": {
"put": {
"tags": [
"Issues"
],
"summary": "Add response to issue",
"operationId": "ApiPublicIssueByIssueIdAddResponsePut",
"parameters": [
{
"name": "issueId",
"in": "path",
"description": "issue id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userLogin",
"in": "query",
"description": "Login of the user adding responses to the issue. (Required when logging in is not done using a login and password)",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "issue response",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueResponse"
}
],
"description": "Issue response"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueResponse"
}
],
"description": "Issue response"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueResponse"
}
],
"description": "Issue response"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueResponse"
}
],
"description": "Issue response"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/issue/{issueId}/addAttachments": {
"put": {
"tags": [
"Issues"
],
"summary": "Add attachments to issue",
"operationId": "ApiPublicIssueByIssueIdAddAttachmentsPut",
"parameters": [
{
"name": "issueId",
"in": "path",
"description": "issue id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "userLogin",
"in": "query",
"description": "Login of the user adding attachments to the issue. (Required when logging in is not done using a login and password)",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "list of issue attachments",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/user/{userId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get user data by providing system-generated ID",
"operationId": "ApiPublicUserByUserIdGet",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIUserResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/user/byUserLogin": {
"get": {
"tags": [
"Users"
],
"summary": "Get user data by providing user login",
"operationId": "ApiPublicUserByUserLoginGet",
"parameters": [
{
"name": "userLogin",
"in": "query",
"description": "user login",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIUserResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/users": {
"get": {
"tags": [
"Users"
],
"summary": "Get all users",
"operationId": "ApiPublicUsersGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIUserResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/user/{userId}/block": {
"put": {
"tags": [
"Users"
],
"summary": "Block user",
"operationId": "ApiPublicUserByUserIdBlockPut",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "reason",
"in": "query",
"description": "Block user account reason. Optional - Default = Other\n\n1 = UserContractClosed\n\n2 = UserTemporarySuspended\n\n3 = RedundantAccount\n\n4 = Other",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIBlockUserReason"
}
]
},
"x-enumNames": [
"UserContractClosed",
"UserTemporarySuspended",
"RedundantAccount",
"Other"
]
},
{
"name": "message",
"in": "query",
"description": "Message - visible to the user. Optional - Default = empty",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/user/{userId}/unblock": {
"put": {
"tags": [
"Users"
],
"summary": "Unblock user",
"operationId": "ApiPublicUserByUserIdUnblockPut",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/user/{userId}/permissions/documentAccessRules": {
"get": {
"tags": [
"Users"
],
"summary": "Get document access rules for a user (requires ULTRA service level)",
"operationId": "ApiPublicUserByUserIdPermissionsDocumentAccessRulesGet",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentAccessRuleResultIEnumerableAPIDataResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Add a document access rule for a user (requires ULTRA service level).\r\nAllowAll is mutually exclusive with tags/withoutTagFromGroupId. Tags and withoutTagFromGroupId can be combined.",
"operationId": "ApiPublicUserByUserIdPermissionsDocumentAccessRulesPost",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "rule definition",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAccessRule"
}
],
"description": "Document access rule - controls which documents a user can see (input).\r\nUsed with POST /user/{userId}/permissions/documentAccessRules"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAccessRule"
}
],
"description": "Document access rule - controls which documents a user can see (input).\r\nUsed with POST /user/{userId}/permissions/documentAccessRules"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAccessRule"
}
],
"description": "Document access rule - controls which documents a user can see (input).\r\nUsed with POST /user/{userId}/permissions/documentAccessRules"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAccessRule"
}
],
"description": "Document access rule - controls which documents a user can see (input).\r\nUsed with POST /user/{userId}/permissions/documentAccessRules"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/user/{userId}/permissions/documentAccessRules/{uniqueKey}": {
"delete": {
"tags": [
"Users"
],
"summary": "Remove a document access rule for a user (requires ULTRA service level)",
"operationId": "ApiPublicUserByUserIdPermissionsDocumentAccessRulesByUniqueKeyDelete",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "uniqueKey",
"in": "path",
"description": "unique key of the rule to remove",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/user/{userId}/permissions/documentAcceptanceRules/{orgStructureId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get document acceptance rules for a user on a specific organization structure (requires ULTRA service level)",
"operationId": "ApiPublicUserByUserIdPermissionsDocumentAcceptanceRulesByOrgStructureIdGet",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orgStructureId",
"in": "path",
"description": "organization structure id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentAcceptanceRuleResultIEnumerableAPIDataResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Add a document acceptance rule for a user on a specific organization structure (requires ULTRA service level).\r\nAllowAll is mutually exclusive with tags/withoutTagFromGroupId. Tags and withoutTagFromGroupId can be combined.",
"operationId": "ApiPublicUserByUserIdPermissionsDocumentAcceptanceRulesByOrgStructureIdPost",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orgStructureId",
"in": "path",
"description": "organization structure id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "rule definition",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAcceptanceRule"
}
],
"description": "Document acceptance rule - controls which documents a user can accept (input).\r\nUsed with POST /user/{userId}/permissions/documentAcceptanceRules/{orgStructureId}\r\nThe orgStructureId is provided via URL path, not in the request body."
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAcceptanceRule"
}
],
"description": "Document acceptance rule - controls which documents a user can accept (input).\r\nUsed with POST /user/{userId}/permissions/documentAcceptanceRules/{orgStructureId}\r\nThe orgStructureId is provided via URL path, not in the request body."
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAcceptanceRule"
}
],
"description": "Document acceptance rule - controls which documents a user can accept (input).\r\nUsed with POST /user/{userId}/permissions/documentAcceptanceRules/{orgStructureId}\r\nThe orgStructureId is provided via URL path, not in the request body."
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAcceptanceRule"
}
],
"description": "Document acceptance rule - controls which documents a user can accept (input).\r\nUsed with POST /user/{userId}/permissions/documentAcceptanceRules/{orgStructureId}\r\nThe orgStructureId is provided via URL path, not in the request body."
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/user/{userId}/permissions/documentAcceptanceRules/{uniqueKey}": {
"delete": {
"tags": [
"Users"
],
"summary": "Remove a document acceptance rule for a user (requires ULTRA service level)",
"operationId": "ApiPublicUserByUserIdPermissionsDocumentAcceptanceRulesByUniqueKeyDelete",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "user id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "uniqueKey",
"in": "path",
"description": "unique key of the rule to remove",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/users/structures": {
"get": {
"tags": [
"Users"
],
"summary": "Get organization structures available for permissions management (requires ULTRA service level)",
"operationId": "ApiPublicUsersStructuresGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIOrganizationStructureResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/vehicle/{vehicleId}": {
"get": {
"tags": [
"Vehicles"
],
"summary": "Get vehicle data by providing system-generated ID",
"operationId": "ApiPublicVehicleByVehicleIdGet",
"parameters": [
{
"name": "vehicleId",
"in": "path",
"description": "vehicle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIVehicleResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Vehicles"
],
"summary": "Update vehicle item",
"operationId": "ApiPublicVehicleByVehicleIdPut",
"parameters": [
{
"name": "vehicleId",
"in": "path",
"description": "vehicle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "vehicle object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicle"
}
],
"description": "Vehicle object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Vehicles"
],
"summary": "Delete vehicle item",
"operationId": "ApiPublicVehicleByVehicleIdDelete",
"parameters": [
{
"name": "vehicleId",
"in": "path",
"description": "vehicle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/vehicle/byRegistrationNumber": {
"get": {
"tags": [
"Vehicles"
],
"summary": "Get vehicle data by registration number",
"operationId": "ApiPublicVehicleByRegistrationNumberGet",
"parameters": [
{
"name": "registrationNumber",
"in": "query",
"description": "vehicle registration number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIVehicleResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/vehicles": {
"get": {
"tags": [
"Vehicles"
],
"summary": "Get all vehicles",
"operationId": "ApiPublicVehiclesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIVehicleResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/vehicle": {
"post": {
"tags": [
"Vehicles"
],
"summary": "Add new vehicle item",
"operationId": "ApiPublicVehiclePost",
"requestBody": {
"description": "Vehicle object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicle"
}
],
"description": "Vehicle object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/vehicle/{vehicleId}/setMileage": {
"put": {
"tags": [
"Vehicles"
],
"summary": "Set vehicle Mileage",
"operationId": "ApiPublicVehicleByVehicleIdSetMileagePut",
"parameters": [
{
"name": "vehicleId",
"in": "path",
"description": "vehicle id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "mileage",
"in": "query",
"description": "vehicle mileage",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/customDictionary/{customDictionaryId}": {
"get": {
"tags": [
"Custom Dictionaries"
],
"summary": "Get custom dictionary data by providing system-generated ID - only for Ultimate accounts level",
"operationId": "ApiPublicCustomDictionaryByCustomDictionaryIdGet",
"parameters": [
{
"name": "customDictionaryId",
"in": "path",
"description": "custom dictionary id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICustomDictionaryResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/customDictionaries": {
"get": {
"tags": [
"Custom Dictionaries"
],
"summary": "Get all custom dictionaries - only for Ultimate accounts level",
"operationId": "ApiPublicCustomDictionariesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICustomDictionaryResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/customDictionary/{customDictionaryId}/items": {
"get": {
"tags": [
"Custom Dictionaries"
],
"summary": "Get list of custom dictionary items by providing custom dictionary system-generated ID - only for Ultimate accounts level",
"operationId": "ApiPublicCustomDictionaryByCustomDictionaryIdItemsGet",
"parameters": [
{
"name": "customDictionaryId",
"in": "path",
"description": "custom dictionary id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICustomDictionaryItemResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/customDictionary/item/{customDictionaryItemId}": {
"get": {
"tags": [
"Custom Dictionaries"
],
"summary": "Get custom dictionary item data by providing system-generated ID - only for Ultimate accounts level",
"operationId": "ApiPublicCustomDictionaryItemByCustomDictionaryItemIdGet",
"parameters": [
{
"name": "customDictionaryItemId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APICustomDictionaryItemResultAPIDataResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Custom Dictionaries"
],
"summary": "Update custom dictionary item (only for Standard dictionary type) - only for Ultimate accounts level",
"operationId": "ApiPublicCustomDictionaryItemByCustomDictionaryItemIdPut",
"parameters": [
{
"name": "customDictionaryItemId",
"in": "path",
"description": "custom dictionary item id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "custom dictionary item object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APICustomDictionaryItem"
}
],
"description": "Custom dictionary item"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Custom Dictionaries"
],
"summary": "Delete custom dictionary item (only for Standard dictionary type) - only for Ultimate accounts level",
"operationId": "ApiPublicCustomDictionaryItemByCustomDictionaryItemIdDelete",
"parameters": [
{
"name": "customDictionaryItemId",
"in": "path",
"description": "custom dictionary item id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/customDictionary/item": {
"post": {
"tags": [
"Custom Dictionaries"
],
"summary": "Add new custom dictionary item (only for Standard dictionary type) - only for Ultimate accounts level",
"operationId": "ApiPublicCustomDictionaryItemPost",
"requestBody": {
"description": "Custom dictionary item object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APICustomDictionaryItem"
}
],
"description": "Custom dictionary item"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/analysis/documents": {
"get": {
"tags": [
"Analysis - only for Ultra+ accounts level"
],
"summary": "Get all documents with analysis from selected period",
"operationId": "ApiPublicAnalysisDocumentsGet",
"parameters": [
{
"name": "yearFrom",
"in": "query",
"description": "year from - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthFrom",
"in": "query",
"description": "month from - optional, first month (January) if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearTo",
"in": "query",
"description": "year to - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthTo",
"in": "query",
"description": "month to - optional, current month if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "direction",
"in": "query",
"description": "document direction (-1-costs, 1-revenues, 0-unknown) - optional, all directions if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentAnalysisResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/analysis/documents/byTagGroup": {
"get": {
"tags": [
"Analysis - only for Ultra+ accounts level"
],
"summary": "Get all documents with analysis by tag group from selected period",
"operationId": "ApiPublicAnalysisDocumentsByTagGroupGet",
"parameters": [
{
"name": "tagGroupId",
"in": "query",
"description": "Tag group ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearFrom",
"in": "query",
"description": "year from - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthFrom",
"in": "query",
"description": "month from - optional, first month (January) if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearTo",
"in": "query",
"description": "year to - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthTo",
"in": "query",
"description": "month to - optional, current month if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "direction",
"in": "query",
"description": "document direction (-1-costs, 1-revenues, 0-unknown) - optional, all directions if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentAnalysisByTagGroupResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/analysis/documents/withDimensions": {
"get": {
"tags": [
"Analysis - only for Ultra+ accounts level"
],
"summary": "Get all documents with analysis from selected period, including the cost dimension details",
"operationId": "ApiPublicAnalysisDocumentsWithDimensionsGet",
"parameters": [
{
"name": "yearFrom",
"in": "query",
"description": "year from - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthFrom",
"in": "query",
"description": "month from - optional, first month (January) if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearTo",
"in": "query",
"description": "year to - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthTo",
"in": "query",
"description": "month to - optional, current month if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "direction",
"in": "query",
"description": "document direction (-1-costs, 1-revenues, 0-unknown) - optional, all directions if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeAllTagDimensions",
"in": "query",
"description": "if true (default), returns all available tag dimensions regardless of whether they have a value",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentWithDimensionsResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/analysis/documents/{documentId}/withDimensions": {
"get": {
"tags": [
"Analysis - only for Ultra+ accounts level"
],
"summary": "Get document by id with analysis, including the cost dimension details",
"operationId": "ApiPublicAnalysisDocumentsByDocumentIdWithDimensionsGet",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeAllTagDimensions",
"in": "query",
"description": "if true (default), returns all available tag dimensions regardless of whether they have a value",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentWithDimensionsResultAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/analysis/invoices": {
"get": {
"tags": [
"Analysis - only for Ultra+ accounts level"
],
"summary": "Get all invoices with analysis from selected period",
"operationId": "ApiPublicAnalysisInvoicesGet",
"parameters": [
{
"name": "yearFrom",
"in": "query",
"description": "year from - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthFrom",
"in": "query",
"description": "month from - optional, first month (January) if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearTo",
"in": "query",
"description": "year to - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthTo",
"in": "query",
"description": "month to - optional, current month if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "direction",
"in": "query",
"description": "invoice direction (-1-costs, 1-revenues, 0-unknown) - optional, all directions if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceAnalysisResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/analysis/invoices/withDimensions": {
"get": {
"tags": [
"Analysis - only for Ultra+ accounts level"
],
"summary": "Get all invoices with analysis from selected period with dimensions",
"operationId": "ApiPublicAnalysisInvoicesWithDimensionsGet",
"parameters": [
{
"name": "yearFrom",
"in": "query",
"description": "year from - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthFrom",
"in": "query",
"description": "month from - optional, first month (January) if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearTo",
"in": "query",
"description": "year to - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthTo",
"in": "query",
"description": "month to - optional, current month if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "direction",
"in": "query",
"description": "invoice direction (-1-costs, 1-revenues, 0-unknown) - optional, all directions if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceWithDimensionsResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/analysis/invoices/byTagGroup": {
"get": {
"tags": [
"Analysis - only for Ultra+ accounts level"
],
"summary": "Get all invoices with analysis by tag group from selected period",
"operationId": "ApiPublicAnalysisInvoicesByTagGroupGet",
"parameters": [
{
"name": "tagGroupId",
"in": "query",
"description": "Tag group ID (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearFrom",
"in": "query",
"description": "year from - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthFrom",
"in": "query",
"description": "month from - optional, first month (January) if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "yearTo",
"in": "query",
"description": "year to - optional, current year if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "monthTo",
"in": "query",
"description": "month to - optional, current month if missing",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "direction",
"in": "query",
"description": "invoice direction (-1-costs, 1-revenues, 0-unknown) - optional, all directions if missing",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIInvoiceAnalysisByTagGroupResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/AI/document": {
"post": {
"tags": [
"AccountantX AI - for Ultimate accounts level with AI services enabled"
],
"summary": "Add a new document\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicAIDocumentPost",
"parameters": [
{
"name": "executeRules",
"in": "query",
"description": "Execute rules on document, only ULTRA+ - optional, no if missing, (0) - no, (1) - yes",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Document object",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocument"
}
],
"description": "Document (add or modify operation)"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/AI/document/ksef": {
"post": {
"tags": [
"AccountantX AI - for Ultimate accounts level with AI services enabled"
],
"summary": "Add a new document from KSeF XML.",
"operationId": "ApiPublicAIDocumentKsefPost",
"requestBody": {
"description": "KSeF import request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentKSeFImportRequest"
}
],
"description": "Request model for importing a KSeF invoice from XML via Public API."
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/AI/documents/readyToExternalProcess": {
"get": {
"tags": [
"AccountantX AI - for Ultimate accounts level with AI services enabled"
],
"summary": "Get all documents ready to external process",
"operationId": "ApiPublicAIDocumentsReadyToExternalProcessGet",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "limit number of documents (optional)",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeAllTagDimensions",
"in": "query",
"description": "if true, returns all available tag dimensions regardless of whether they have a value (default false)",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentWithAIAndDimensionsResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/AI/documents/readyToBook": {
"get": {
"tags": [
"AccountantX AI - for Ultimate accounts level with AI services enabled"
],
"summary": "Get all ready to book documents",
"operationId": "ApiPublicAIDocumentsReadyToBookGet",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "limit number of documents (optional)",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeAllTagDimensions",
"in": "query",
"description": "if true, returns all available tag dimensions regardless of whether they have a value (default false)",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIDocumentWithAIAndDimensionsResultIEnumerableAPIDataResponse"
}
}
}
}
}
}
},
"/api/public/AI/document/{documentId}/setAsProcessed": {
"put": {
"tags": [
"AccountantX AI - for Ultimate accounts level with AI services enabled"
],
"summary": "Mark document as externally processed",
"operationId": "ApiPublicAIDocumentByDocumentIdSetAsProcessedPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/AI/document/{documentId}/setAsBooked": {
"put": {
"tags": [
"AccountantX AI - for Ultimate accounts level with AI services enabled"
],
"summary": "Mark document as booked",
"operationId": "ApiPublicAIDocumentByDocumentIdSetAsBookedPut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/AI/document/{documentId}/attachments/internal/addFile": {
"put": {
"tags": [
"AccountantX AI - for Ultimate accounts level with AI services enabled"
],
"summary": "Add internal attachments to document for attachment processing",
"operationId": "ApiPublicAIDocumentByDocumentIdAttachmentsInternalAddFilePut",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "document id (system generated)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "list of document internal attachments",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/status": {
"get": {
"tags": [
"General"
],
"summary": "Check service status (working or maintenance)",
"operationId": "ApiPublicStatusGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIResponse"
}
}
}
}
}
}
},
"/api/public/contextinfo": {
"get": {
"tags": [
"General"
],
"summary": "Get meta-information about current session (i.e. customer name), authentication required\r\n\r\nThis method supports delegation.",
"operationId": "ApiPublicContextinfoGet",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContextInfoAPIDataResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AIDetails": {
"type": "object",
"properties": {
"AI_Status": {
"type": "integer",
"description": "Status AI",
"format": "int32",
"nullable": true
},
"AI_Message": {
"type": "string",
"description": "Informacje o ewentualnych bledach",
"nullable": true
}
},
"additionalProperties": false,
"description": "Informacje o procesie AI"
},
"APIAbsenceAttachment": {
"type": "object",
"properties": {
"AttachmentId": {
"type": "integer",
"description": "Attachment ID",
"format": "int32"
},
"FileName": {
"type": "string",
"description": "Original file name",
"nullable": true
},
"ContentType": {
"type": "string",
"description": "Content type",
"nullable": true
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": "Absence attachment file"
},
"APIAbsenceRequestAffiliationTypeEnum": {
"enum": [
0,
1
],
"type": "integer",
"description": "Affiliation type enum\r\n\r\n0 - [Employee] - employee\r\n1 - [Partner] - partner\n\n0 = Employee\n\n1 = Partner",
"format": "int32",
"x-enumNames": [
"Employee",
"Partner"
]
},
"APIAbsenceRequestBase": {
"required": [
"Periods"
],
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/AbsenceGeneral"
}
],
"description": "General section",
"nullable": true
},
"UserDetails": {
"allOf": [
{
"$ref": "#/components/schemas/UserDetails"
}
],
"description": "User details",
"nullable": true
},
"AbsenceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AbsenceDetails"
}
],
"description": "Absence details (duration/description)",
"nullable": true
},
"Periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAbsenceRequestPeriod"
},
"description": "Absence request periods"
}
},
"additionalProperties": false,
"description": "Absence Request object [base]"
},
"APIAbsenceRequestPeriod": {
"type": "object",
"properties": {
"DateFrom": {
"type": "string",
"description": "Date from",
"format": "date-time"
},
"DateTo": {
"type": "string",
"description": "Date to",
"format": "date-time"
},
"HourFrom": {
"type": "string",
"description": "Hour from (HH:mm)",
"nullable": true
},
"HourTo": {
"type": "string",
"description": "Hour to (HH:mm)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Absence request period object"
},
"APIAbsenceRequestResult": {
"required": [
"Periods"
],
"type": "object",
"properties": {
"AbsenceRequestId": {
"type": "integer",
"description": "ID of absence request",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/AbsenceGeneral"
}
],
"description": "General section",
"nullable": true
},
"UserDetails": {
"allOf": [
{
"$ref": "#/components/schemas/UserDetails"
}
],
"description": "User details",
"nullable": true
},
"AbsenceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AbsenceDetails"
}
],
"description": "Absence details (duration/description)",
"nullable": true
},
"Periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAbsenceRequestPeriod"
},
"description": "Absence request periods"
}
},
"additionalProperties": false,
"description": "Absence Request object [result]"
},
"APIAbsenceRequestResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAbsenceRequestResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAbsenceRequestResultOne": {
"required": [
"Periods"
],
"type": "object",
"properties": {
"AbsenceRequestId": {
"type": "integer",
"description": "ID of absence request",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/AbsenceGeneral"
}
],
"description": "General section",
"nullable": true
},
"UserDetails": {
"allOf": [
{
"$ref": "#/components/schemas/UserDetails"
}
],
"description": "User details",
"nullable": true
},
"AbsenceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AbsenceDetails"
}
],
"description": "Absence details (duration/description)",
"nullable": true
},
"Periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAbsenceRequestPeriod"
},
"description": "Absence request periods"
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAbsenceAttachment"
},
"description": "Absence attachments",
"nullable": true
},
"AcceptanceInfo": {
"allOf": [
{
"$ref": "#/components/schemas/AcceptanceInfo"
}
],
"description": "Acceptance info",
"nullable": true
},
"RejectionInfo": {
"allOf": [
{
"$ref": "#/components/schemas/RejectionInfo"
}
],
"description": "Rejection info",
"nullable": true
},
"ClarificationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/ClarificationInfo"
}
],
"description": "Clarification info",
"nullable": true
},
"RegistrationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/RegistrationInfo"
}
],
"description": "Registration info",
"nullable": true
}
},
"additionalProperties": false,
"description": "Absence Request object [result one]"
},
"APIAbsenceRequestResultOneAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIAbsenceRequestResultOne"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAbsenceRequestStatusEnum": {
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer",
"description": "Absence request status enum\r\n\r\n0 - [Waiting] - waiting\r\n1 - [Accepted] - accepted\r\n2 - [Rejected] - rejected\r\n3 - [Registered] - registered\r\n4 - [ToClarify] - to clarify\r\n5 - [WaitingForVerification] - waiting for verification\n\n0 = Waiting\n\n1 = Accepted\n\n2 = Rejected\n\n3 = Registered\n\n4 = ToClarify\n\n5 = WaitingForVerification",
"format": "int32",
"x-enumNames": [
"Waiting",
"Accepted",
"Rejected",
"Registered",
"ToClarify",
"WaitingForVerification"
]
},
"APIAbsenceRequestTypeEnum": {
"enum": [
1,
2,
3,
4,
6,
8,
9,
10,
11,
12,
14,
15
],
"type": "integer",
"description": "Absence type enum\r\n\r\n1 - [VacationLeave] - vacation leave\r\n2 - [LeaveOnDemand] - leave on demand\r\n3 - [SpecialLeave] - special leave\r\n4 - [UnpaidLeave] - unpaid leave\r\n6 - [MaternityLeave] - maternity leave\r\n8 - [PaternityLeave] - paternity leave\r\n9 - [ParentalLeave] - parental leave\r\n10 - [ChildrencareLeave] - childrencare leave\r\n11 - [CaregiverLeave] - caregiver leave\r\n12 - [OtherLeave] - other leave\r\n14 - [ServiseSuspensionUnpaid] - servise suspension unpaid\r\n15 - [ServiseSuspensionPaid] - servise suspension paid\n\n1 = VacationLeave\n\n2 = LeaveOnDemand\n\n3 = SpecialLeave\n\n4 = UnpaidLeave\n\n6 = MaternityLeave\n\n8 = PaternityLeave\n\n9 = ParentalLeave\n\n10 = ChildcareLeave\n\n11 = CaregiverLeave\n\n12 = OtherLeave\n\n14 = ServiseSuspensionUnpaid\n\n15 = ServiseSuspensionPaid",
"format": "int32",
"x-enumNames": [
"VacationLeave",
"LeaveOnDemand",
"SpecialLeave",
"UnpaidLeave",
"MaternityLeave",
"PaternityLeave",
"ParentalLeave",
"ChildcareLeave",
"CaregiverLeave",
"OtherLeave",
"ServiseSuspensionUnpaid",
"ServiseSuspensionPaid"
]
},
"APIAccDictionary": {
"type": "object",
"properties": {
"DictionaryID": {
"type": "integer",
"description": "Dictionary ID",
"format": "int32"
},
"DictionaryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAccDictionaryItem"
},
"description": "List of dictionary items",
"nullable": true
}
},
"additionalProperties": false,
"description": "Dictionary of chart of accounts object"
},
"APIAccDictionaryAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIAccDictionary"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAccDictionaryItem": {
"type": "object",
"properties": {
"Analitics": {
"type": "integer",
"description": "Analytics value for item",
"format": "int32"
},
"Name": {
"type": "string",
"description": "Item name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Dictionary item of chart of accounts object"
},
"APIAccountAssingmentMethod": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"type": "integer",
"description": "Method of document accounting:\r\n\r\n1 - [PurchaseGeneral] - Purchase (general)\r\n2 - [PurchaseArticle] - Purchase for resale\r\n3 - [PurchaseNoVatDeduction] - Purchase no VAT deduction\r\n4 - [General] - General \r\n5 - [None] - None\r\n6 - [Service] - Purchase of a service\r\n7 - [Asset] - Asset\r\n8 - [PurchaseHalfVatDeduction] - Purchase 50% VAT Deduction (i.e. car costs)\r\n9 - [CostNoTaxDeductionWithVatDeduction] - No TAX Deduction, but VAT Deduction\r\n10 - [CostNoTaxAndVatDeduction] - No TAX and VAT Deduction\n\n1 = PurchaseGeneral\n\n2 = PurchaseArticle\n\n3 = PurchaseNoVatDeduction\n\n4 = General\n\n5 = None\n\n6 = Service\n\n7 = Asset\n\n8 = PurchaseHalfVatDeduction\n\n9 = CostNoTaxDeductionWithVatDeduction\n\n10 = CostNoTaxAndVatDeduction",
"format": "int32",
"x-enumNames": [
"PurchaseGeneral",
"PurchaseArticle",
"PurchaseNoVatDeduction",
"General",
"None",
"Service",
"Asset",
"PurchaseHalfVatDeduction",
"CostNoTaxDeductionWithVatDeduction",
"CostNoTaxAndVatDeduction"
]
},
"APIAccountCategory": {
"type": "object",
"properties": {
"AccountCategoryId": {
"type": "integer",
"description": "Category ID",
"format": "int32",
"nullable": true
},
"AccountCategoryName": {
"type": "string",
"description": "Category name",
"nullable": true
},
"Type": {
"type": "integer",
"description": "Category type: -1 - costs document, 1 - revenue documents; 0 - unknown documents",
"format": "int32",
"nullable": true
},
"BarcodeRegex": {
"type": "string",
"description": "Regular expression based on barcode to detect category",
"nullable": true
},
"ParentId": {
"type": "integer",
"description": "Category parent ID",
"format": "int32",
"nullable": true
},
"IsGroup": {
"type": "boolean",
"description": "If category is a group"
},
"IsDefault": {
"type": "boolean",
"description": "If category is default in group"
}
},
"additionalProperties": false,
"description": "Document accounting category"
},
"APIAccountCategoryIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAccountCategory"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAccountValue": {
"type": "object",
"properties": {
"Month": {
"type": "integer",
"description": "Month",
"format": "int32"
},
"Value": {
"type": "number",
"description": "Value",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Account value object"
},
"APIAccountValueIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAccountValue"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAccountingDocument": {
"type": "object",
"properties": {
"AccountingDocumentId": {
"type": "integer",
"description": "Accounting document ID (internal)",
"format": "int32"
},
"RecordsNumber": {
"type": "string",
"description": "Document number in the general ledger",
"nullable": true
},
"IssueDate": {
"type": "string",
"description": "Date of issue of the document",
"format": "date-time",
"nullable": true
},
"AccoutingDate": {
"type": "string",
"description": "Date of accounting of the document",
"format": "date-time",
"nullable": true
},
"ContractorName": {
"type": "string",
"description": "Contractor name",
"nullable": true
},
"ContractorIdentifier": {
"type": "string",
"description": "Contractor TaxID",
"nullable": true
},
"TotalNet": {
"type": "number",
"description": "Total Net / whole document",
"format": "double",
"nullable": true
},
"TotalGross": {
"type": "number",
"description": "Total Gross / whole document",
"format": "double",
"nullable": true
},
"Number": {
"type": "string",
"description": "Document Number",
"nullable": true
},
"Title": {
"type": "string",
"description": "Document Title",
"nullable": true
},
"Type": {
"type": "string",
"description": "Document Type (may vary depending on the source ERP)",
"nullable": true
},
"DocumentId": {
"type": "integer",
"description": "ID of the associated scanned document (internal)",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Accounting Document object"
},
"APIAccountingDocumentIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAccountingDocument"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAccountingFinancialFunction": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16
],
"type": "integer",
"description": " Accounting financial function:\r\n\r\n1 - [Debit] - Debit\r\n2 - [Credit] - Credit\r\n3 - [DebitYTD] - Debit year to date\r\n4 - [CreditYTD] - Credit year to date\r\n5 - [BalanceDebit] - Balance debit\r\n6 - [BalanceCredit] - Balance credit\r\n7 - [BalanceDebitYTD] - Balance debit year to date\r\n8 - [BalanceCreditYTD] - Balance credit year to date\r\n9 - [PerBalanceDebit] - Per balance debit\r\n10 - [PerBalanceCredit] - Per balance credit\r\n11 - [PerBalanceDebitYTD] - Pre balance debit year to date\r\n12 - [PerBalanceCreditYTD] - Pre balance credit year to date\r\n13 - [OpeningDebit] - Opening balance debit\r\n14 - [OpeningCredit] - Opening balance credit\r\n15 - [OpeningBalanceDebit] - Opening balance debit\r\n16 - [OpeningBalanceCredit] - Opening balance credit\n\n1 = Debit\n\n2 = Credit\n\n3 = DebitYTD\n\n4 = CreditYTD\n\n5 = BalanceDebit\n\n6 = BalanceCredit\n\n7 = BalanceDebitYTD\n\n8 = BalanceCreditYTD\n\n9 = PerBalanceDebit\n\n10 = PerBalanceCredit\n\n11 = PerBalanceDebitYTD\n\n12 = PerBalanceCreditYTD\n\n13 = OpeningDebit\n\n14 = OpeningCredit\n\n15 = OpeningBalanceDebit\n\n16 = OpeningBalanceCredit",
"format": "int32",
"x-enumNames": [
"Debit",
"Credit",
"DebitYTD",
"CreditYTD",
"BalanceDebit",
"BalanceCredit",
"BalanceDebitYTD",
"BalanceCreditYTD",
"PerBalanceDebit",
"PerBalanceCredit",
"PerBalanceDebitYTD",
"PerBalanceCreditYTD",
"OpeningDebit",
"OpeningCredit",
"OpeningBalanceDebit",
"OpeningBalanceCredit"
]
},
"APIAccountingLineBasedOnTags": {
"type": "object",
"properties": {
"Account": {
"maxLength": 1000,
"type": "string",
"description": "Artybut Account",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"LineDescription": {
"maxLength": 500,
"type": "string",
"description": "Line description",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags",
"nullable": true
},
"DefaultTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Default Tags (if some tags groups are missing on document)",
"nullable": true
},
"AccountingSchemaRuleName": {
"type": "string",
"description": "AccountingSchemaRule Name - for developer purpose only",
"nullable": true
}
},
"additionalProperties": false,
"description": "One line for accounts based on tags (allocation details)"
},
"APIAccountingRecord": {
"type": "object",
"properties": {
"RecordId": {
"type": "integer",
"description": "Accounting record ID (internal)",
"format": "int32"
},
"AccYearId": {
"type": "integer",
"description": "Accounting year ID",
"format": "int32"
},
"Account": {
"type": "string",
"description": "Accounting account number",
"nullable": true
},
"Number": {
"type": "string",
"description": "Number of accounted document",
"nullable": true
},
"AccoutingDate": {
"type": "string",
"description": "Date of accounting",
"format": "date-time",
"nullable": true
},
"IssueDate": {
"type": "string",
"description": "Date of issue",
"format": "date-time",
"nullable": true
},
"DocumentNumber": {
"type": "string",
"description": "Document Number",
"nullable": true
},
"Debit": {
"type": "number",
"description": "Debit",
"format": "double",
"nullable": true
},
"Credit": {
"type": "number",
"description": "Credit",
"format": "double",
"nullable": true
},
"Description": {
"type": "string",
"description": "Accounting description",
"nullable": true
}
},
"additionalProperties": false,
"description": "Accounting Record object"
},
"APIAccountingRecordIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAccountingRecord"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAccountingYear": {
"type": "object",
"properties": {
"IDAccYear": {
"type": "integer",
"description": "Accounting year Id",
"format": "int32"
},
"AccountingYear": {
"type": "string",
"description": "Accounting year",
"nullable": true
},
"StartYear": {
"type": "integer",
"description": "Start year",
"format": "int32"
},
"StartMonth": {
"type": "integer",
"description": "Start month",
"format": "int32"
},
"EndYear": {
"type": "integer",
"description": "End year",
"format": "int32"
},
"EndMonth": {
"type": "integer",
"description": "End month",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Accounting Year object"
},
"APIAccountingYearIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAccountingYear"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAllocationKey": {
"type": "object",
"properties": {
"AllocationKeyName": {
"type": "string",
"description": "Allocation key name",
"nullable": true
},
"Description": {
"type": "string",
"description": "Allocation key description",
"nullable": true
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKeyTypeEnum"
}
],
"description": "Allocation key type\r\n\r\n0 - [Fixed] - fixed key\r\n1 - [BasedTimesheets] - key based on timesheets \r\n\r\nDefault: Fixed\n\n0 = Fixed\n\n1 = BasedTimesheets",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"TimesheetDetails": {
"allOf": [
{
"$ref": "#/components/schemas/TimesheetDetails"
}
],
"description": "Timesheets details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Allocation key object"
},
"APIAllocationKeyResult": {
"type": "object",
"properties": {
"AllocationKeyId": {
"type": "integer",
"description": "Allocation key ID (internal)",
"format": "int32"
},
"AllocationKeyName": {
"type": "string",
"description": "Allocation key name",
"nullable": true
},
"Description": {
"type": "string",
"description": "Allocation key description",
"nullable": true
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKeyTypeEnum"
}
],
"description": "Allocation key type\r\n\r\n0 - [Fixed] - fixed key\r\n1 - [BasedTimesheets] - key based on timesheets \r\n\r\nDefault: Fixed\n\n0 = Fixed\n\n1 = BasedTimesheets",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"TimesheetDetails": {
"allOf": [
{
"$ref": "#/components/schemas/TimesheetDetails"
}
],
"description": "Timesheets details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Allocation key result object"
},
"APIAllocationKeyResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationKeyResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAllocationKeyResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAllocationKeyResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAllocationKeyTypeEnum": {
"enum": [
0,
1
],
"type": "integer",
"description": "Allocation key type enum\r\n\r\n0 - [Fixed] - fixed key\r\n1 - [BasedTimesheets] - key based on timesheets\n\n0 = Fixed\n\n1 = BasedTimesheets",
"format": "int32",
"x-enumNames": [
"Fixed",
"BasedTimesheets"
]
},
"APIAllocationResult": {
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationGeneral"
}
],
"description": "General information (i.e. cost, income, result)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Allocation (result operation)"
},
"APIAllocationResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIAllocationResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIAuthenticateRequestWithUser": {
"required": [
"Login",
"Password",
"SecretKey"
],
"type": "object",
"properties": {
"SecretKey": {
"minLength": 1,
"type": "string",
"description": "API Key (provided in UI)"
},
"Login": {
"minLength": 1,
"type": "string",
"description": "User login - to change API context"
},
"Password": {
"minLength": 1,
"type": "string",
"description": "User password"
},
"Culture": {
"type": "string",
"description": "Optional. API communication culture (i.e. en-US, pl-PL, etc.)",
"nullable": true
}
},
"additionalProperties": false,
"description": "API Authentication request with User info"
},
"APIBankAccountResult": {
"type": "object",
"properties": {
"BankAccountId": {
"type": "integer",
"description": "Bank account identifier",
"format": "int32"
},
"BankAccountNumber": {
"maxLength": 50,
"type": "string",
"description": "Bank account number",
"nullable": true
},
"BankName": {
"maxLength": 200,
"type": "string",
"description": "The name of the bank",
"nullable": true
},
"IsActive": {
"type": "boolean",
"description": "Whether the account number is active"
},
"SWIFT": {
"maxLength": 50,
"type": "string",
"description": "SWIFT number",
"nullable": true
},
"Currency": {
"maxLength": 30,
"type": "string",
"description": "Currency of bank account",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes to bank account",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bank account [result]"
},
"APIBankAccountResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIBankAccountResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIBankAccountResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIBankAccountResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIBankAccountStatusCode": {
"enum": [
0,
1,
2,
4,
5,
6,
-2,
-1
],
"type": "integer",
"description": "Bank account status on government whitelist:\r\n\r\n-2 - [CannotCheckBankAccountStatus] - No implementation for this process contractor country\r\n-1 - [ErrorWhileCheckingBankAccountStatus] - Government API respond with error\r\n0 - [None] - No verification\r\n1 - [BankAccount_OK_WhiteListed] - Bank account is CORRECT and on the whitelist with specified contractor\r\n2 - [BankAccount_NOT_WhiteListed] - This account is NOT on whitelist or not mapped with specified contractor\r\n4 - [WrongTaxID] - VAT ID is wrong\r\n5 - [EmptyTaxID] - VAT ID is empty\r\n6 - [WrongBankAccount] - Bank account number is invalid\n\n0 = None\n\n1 = BankAccount_OK_WhiteListed\n\n2 = BankAccount_NOT_WhiteListed\n\n4 = WrongTaxID\n\n5 = EmptyTaxID\n\n6 = WrongBankAccount\n\n-2 = CannotCheckBankAccountStatus\n\n-1 = ErrorWhileCheckingBankAccountStatus",
"format": "int32",
"x-enumNames": [
"None",
"BankAccount_OK_WhiteListed",
"BankAccount_NOT_WhiteListed",
"WrongTaxID",
"EmptyTaxID",
"WrongBankAccount",
"CannotCheckBankAccountStatus",
"ErrorWhileCheckingBankAccountStatus"
]
},
"APIBankAccountWithBalanceResult": {
"type": "object",
"properties": {
"BankAccountId": {
"type": "integer",
"description": "Bank account identifier",
"format": "int32"
},
"BankAccountNumber": {
"maxLength": 50,
"type": "string",
"description": "Bank account number",
"nullable": true
},
"BankName": {
"maxLength": 200,
"type": "string",
"description": "The name of the bank",
"nullable": true
},
"IsActive": {
"type": "boolean",
"description": "Whether the account number is active"
},
"SWIFT": {
"maxLength": 50,
"type": "string",
"description": "SWIFT number",
"nullable": true
},
"Currency": {
"maxLength": 30,
"type": "string",
"description": "Currency of bank account",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes to bank account",
"nullable": true
},
"BalanceAmount": {
"type": "number",
"description": "Balance amount",
"format": "double",
"nullable": true
},
"BalanceDate": {
"type": "string",
"description": "Balance date",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bank account with balance [result]"
},
"APIBankAccountWithBalanceResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIBankAccountWithBalanceResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIBankAccountWithBalanceResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIBankAccountWithBalanceResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIBankTransaction": {
"type": "object",
"properties": {
"Flag": {
"type": "integer",
"description": "Flag",
"format": "int32",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Notes",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bank transaction"
},
"APIBankTransactionResult": {
"type": "object",
"properties": {
"BankTransactionId": {
"type": "integer",
"description": "Bank transaction id",
"format": "int32"
},
"BankAccountId": {
"type": "integer",
"description": "Bank account id",
"format": "int32",
"nullable": true
},
"TransactionType": {
"allOf": [
{
"$ref": "#/components/schemas/APIBankTransactionTypeEnum"
}
],
"description": "Transaction type\r\n\r\n0 - [Other] - other\r\n1 - [Transfer] - transfer\r\n2 - [ForeignTransfer] - foreign transfer\r\n3 - [SelfTransfer] - self transfer\r\n4 - [Electric] - electric\r\n100 - [Deposit] - deposit \r\n200 - [VATAccountTransfer] - VAT account transfer\r\n201 - [SocialSecurityTransfer] - social security transfer\r\n202 - [GovTransfer] - government transfer\r\n300 - [CardPayment] - card payment\r\n301 - [CardATM] - card ATM\r\n400 - [BankFees] - bank fees\r\n401 - [Interest] - interest\r\n500 - [Refund] - refund\r\n600 - [Exchange] - exchange\n\n0 = Other\n\n1 = Transfer\n\n2 = ForeignTransfer\n\n3 = SelfTransfer\n\n4 = Deposit\n\n100 = VATAccountTransfer\n\n200 = TaxTransfer\n\n201 = SocialSecurityTransfer\n\n202 = GovTransfer\n\n300 = CardPayment\n\n301 = CardATM\n\n400 = BankFees\n\n401 = Interest\n\n500 = Refund\n\n600 = Exchange",
"nullable": true
},
"Direction": {
"type": "integer",
"description": "Direction",
"format": "int32"
},
"OperationDate": {
"type": "string",
"description": "Operation date",
"format": "date-time",
"nullable": true
},
"AccountingDate": {
"type": "string",
"description": "Accounting date",
"format": "date-time",
"nullable": true
},
"PartyName": {
"type": "string",
"description": "Party name",
"nullable": true
},
"PartyAccountNumber": {
"type": "string",
"description": "Party account number",
"nullable": true
},
"PartySWIFT": {
"type": "string",
"description": "Party SWIFT",
"nullable": true
},
"PartyAddress": {
"type": "string",
"description": "Party address",
"nullable": true
},
"PartyTaxId": {
"type": "string",
"description": "Party tax ID",
"nullable": true
},
"Title": {
"type": "string",
"description": "Title",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"Currency": {
"type": "string",
"description": "Currency",
"nullable": true
},
"BalanceAfter": {
"type": "number",
"description": "Balance after",
"format": "double",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Notes",
"nullable": true
},
"Flag": {
"type": "integer",
"description": "Flag",
"format": "int32",
"nullable": true
},
"IsConfidential": {
"type": "boolean",
"description": "Is confidental",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bank transaction [result]"
},
"APIBankTransactionResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIBankTransactionResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIBankTransactionTypeEnum": {
"enum": [
0,
1,
2,
3,
4,
100,
200,
201,
202,
300,
301,
400,
401,
500,
600
],
"type": "integer",
"description": "Bank transacion type enum\r\n\r\n0 - [Other] - other\r\n1 - [Transfer] - transfer\r\n2 - [ForeignTransfer] - foreign transfer\r\n3 - [SelfTransfer] - self transfer\r\n4 - [Electric] - electric\r\n100 - [Deposit] - deposit \r\n200 - [VATAccountTransfer] - VAT account transfer\r\n201 - [SocialSecurityTransfer] - social security transfer\r\n202 - [GovTransfer] - government transfer\r\n300 - [CardPayment] - card payment\r\n301 - [CardATM] - card ATM\r\n400 - [BankFees] - bank fees\r\n401 - [Interest] - interest\r\n500 - [Refund] - refund\r\n600 - [Exchange] - exchange\n\n0 = Other\n\n1 = Transfer\n\n2 = ForeignTransfer\n\n3 = SelfTransfer\n\n4 = Deposit\n\n100 = VATAccountTransfer\n\n200 = TaxTransfer\n\n201 = SocialSecurityTransfer\n\n202 = GovTransfer\n\n300 = CardPayment\n\n301 = CardATM\n\n400 = BankFees\n\n401 = Interest\n\n500 = Refund\n\n600 = Exchange",
"format": "int32",
"x-enumNames": [
"Other",
"Transfer",
"ForeignTransfer",
"SelfTransfer",
"Deposit",
"VATAccountTransfer",
"TaxTransfer",
"SocialSecurityTransfer",
"GovTransfer",
"CardPayment",
"CardATM",
"BankFees",
"Interest",
"Refund",
"Exchange"
]
},
"APIBatchAccountValueParams": {
"type": "object",
"properties": {
"ExecId": {
"type": "integer",
"description": "Batch execution ID",
"format": "int32"
},
"FinancialFunction": {
"allOf": [
{
"$ref": "#/components/schemas/APIAccountingFinancialFunction"
}
],
"description": "Financial funcio\n\n1 = Debit\n\n2 = Credit\n\n3 = DebitYTD\n\n4 = CreditYTD\n\n5 = BalanceDebit\n\n6 = BalanceCredit\n\n7 = BalanceDebitYTD\n\n8 = BalanceCreditYTD\n\n9 = PerBalanceDebit\n\n10 = PerBalanceCredit\n\n11 = PerBalanceDebitYTD\n\n12 = PerBalanceCreditYTD\n\n13 = OpeningDebit\n\n14 = OpeningCredit\n\n15 = OpeningBalanceDebit\n\n16 = OpeningBalanceCredit",
"x-enumNames": [
"Debit",
"Credit",
"DebitYTD",
"CreditYTD",
"BalanceDebit",
"BalanceCredit",
"BalanceDebitYTD",
"BalanceCreditYTD",
"PerBalanceDebit",
"PerBalanceCredit",
"PerBalanceDebitYTD",
"PerBalanceCreditYTD",
"OpeningDebit",
"OpeningCredit",
"OpeningBalanceDebit",
"OpeningBalanceCredit"
]
},
"AccountNumber": {
"type": "string",
"description": "Account",
"nullable": true
},
"Month": {
"type": "integer",
"description": "Month",
"format": "int32",
"nullable": true
},
"Year": {
"type": "integer",
"description": "Year",
"format": "int32",
"nullable": true
},
"AccountingYearId": {
"type": "integer",
"description": "Accounting Year",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Info object to retrieve AccountValue in batch"
},
"APIBlockUserReason": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "Block user account reason\r\n\r\n1 - [UserContractClosed] - Termination of the user's collaboration with the company\r\n2 - [UserTemporarySuspended] - Temporarily suspend user login\r\n3 - [RedundantAccount] - Block duplicate or test account\r\n4 - [Other] - Other reason\n\n1 = UserContractClosed\n\n2 = UserTemporarySuspended\n\n3 = RedundantAccount\n\n4 = Other",
"format": "int32",
"x-enumNames": [
"UserContractClosed",
"UserTemporarySuspended",
"RedundantAccount",
"Other"
]
},
"APICashDocument": {
"required": [
"Items",
"Title"
],
"type": "object",
"properties": {
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICashDocumentItem"
},
"description": "Cash document items"
},
"TreasuryCode": {
"maxLength": 50,
"type": "string",
"description": "Cash document treasury code",
"nullable": true
},
"CashDocumentType": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocumentTypeEnum"
}
],
"description": "Cash document type\r\n\r\n1 - [Withdrawal] - withdrawal\r\n2 - [Deposit] - deposit \r\n3 - [TempWithdrawal] - temporary withdrawal\r\n4 - [TempDeposit] - temporary deposit\r\n5 - [OpenBalance] - opening balance \r\n\r\nDefault: 1 - [Withdrawal] - withdrawal\n\n1 = Withdrawal\n\n2 = Deposit\n\n3 = TempWithdrawal\n\n4 = TempDeposit\n\n5 = OpenBalance",
"x-enumNames": [
"Withdrawal",
"Deposit",
"TempWithdrawal",
"TempDeposit",
"OpenBalance"
]
},
"Title": {
"maxLength": 500,
"minLength": 1,
"type": "string",
"description": "Cash document title"
},
"Number": {
"maxLength": 100,
"type": "string",
"description": "Cash document number\r\n\r\nOptional - autogenerated by default",
"nullable": true
},
"Date": {
"type": "string",
"description": "Cash document date\r\n\r\nOptional. Default today",
"format": "date-time",
"nullable": true
},
"MadeOutBy": {
"maxLength": 200,
"type": "string",
"description": "Person who made out this cash document\r\n\r\nOptional. Default empty",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Cash documents Notes",
"nullable": true
},
"OperatorType": {
"allOf": [
{
"$ref": "#/components/schemas/APIOperatorTypeEnum"
}
],
"description": "Cash document operator type enum\r\n\r\n1 - [Contractor] - contractor\r\n2 - [Employee] - employee\r\n\r\nDefault: 1 - [Contractor] - contractor\n\n1 = Contractor\n\n2 = Employee",
"x-enumNames": [
"Contractor",
"Employee"
]
},
"OperatorIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIOperatorIdentifierTypeEnum"
}
],
"description": "Operator identifier type\r\n\r\n1 - [TaxID] - Tax ID i.e. NIP\r\n2 - [PersonalID] - Personal ID i.e. PESEL\r\n\r\nDefault: 1 - [TaxID] - Tax ID i.e. NIP\n\n1 = TaxID\n\n2 = PersonalID",
"nullable": true
},
"OperatorIdentifier": {
"maxLength": 50,
"type": "string",
"description": "Operator identifier",
"nullable": true
},
"OperatorName": {
"maxLength": 200,
"type": "string",
"description": "Operator name",
"nullable": true
},
"OperatorAddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Operator address street",
"nullable": true
},
"OperatorAddressCity": {
"maxLength": 200,
"type": "string",
"description": "Operator address city",
"nullable": true
},
"ContractorId": {
"type": "integer",
"description": "Contractor ID (system generated) related with cash document",
"format": "int32",
"nullable": true
},
"EmployeeUserId": {
"type": "integer",
"description": "Employee ID (system generated) related with cash document",
"format": "int32",
"nullable": true
},
"IsAdvanceForEmployee": {
"type": "boolean",
"description": "Is document related with advance payments for employees\r\n\r\nOptional. Default false. \r\nOnly for POWER and above service level."
}
},
"additionalProperties": false,
"description": "Cash document object"
},
"APICashDocumentChange": {
"required": [
"Title"
],
"type": "object",
"properties": {
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICashDocumentItem"
},
"description": "Cash document items",
"nullable": true
},
"Title": {
"maxLength": 500,
"minLength": 1,
"type": "string",
"description": "Cash document title"
},
"Number": {
"maxLength": 100,
"type": "string",
"description": "Cash document number\r\n\r\nOptional - autogenerated by default",
"nullable": true
},
"Date": {
"type": "string",
"description": "Cash document date\r\n\r\nOptional. Default today",
"format": "date-time",
"nullable": true
},
"MadeOutBy": {
"maxLength": 200,
"type": "string",
"description": "Person who made out this cash document\r\n\r\nOptional. Default empty",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Cash documents Notes",
"nullable": true
},
"OperatorIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIOperatorIdentifierTypeEnum"
}
],
"description": "Operator identifier type\r\n\r\n1 - [TaxID] - Tax ID i.e. NIP\r\n2 - [PersonalID] - Personal ID i.e. PESEL\r\n\r\nDefault: 1 - [TaxID] - Tax ID i.e. NIP\n\n1 = TaxID\n\n2 = PersonalID",
"nullable": true
},
"OperatorIdentifier": {
"maxLength": 50,
"type": "string",
"description": "Operator identifier",
"nullable": true
},
"OperatorName": {
"maxLength": 200,
"type": "string",
"description": "Operator name",
"nullable": true
},
"OperatorAddressCity": {
"maxLength": 200,
"type": "string",
"description": "Operator address city",
"nullable": true
},
"OperatorAddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Operator address street",
"nullable": true
},
"ContractorId": {
"type": "integer",
"description": "Contractor ID (system generated) related with cash document",
"format": "int32",
"nullable": true
},
"EmployeeUserId": {
"type": "integer",
"description": "Employee ID (system generated) related with cash document",
"format": "int32",
"nullable": true
},
"IsAdvanceForEmployee": {
"type": "boolean",
"description": "Is document related with advance payments for employees\r\n\r\nOptional. Default false",
"nullable": true
}
},
"additionalProperties": false,
"description": "Cash document change object"
},
"APICashDocumentItem": {
"required": [
"Title",
"Value"
],
"type": "object",
"properties": {
"Title": {
"maxLength": 500,
"minLength": 1,
"type": "string",
"description": "Cash document item title"
},
"Value": {
"type": "number",
"description": "Cash document item title",
"format": "double"
}
},
"additionalProperties": false,
"description": "Cash document item object"
},
"APICashDocumentItemResult": {
"required": [
"CashDocumentItemId",
"Title",
"Value"
],
"type": "object",
"properties": {
"CashDocumentItemId": {
"type": "integer",
"description": "Cash document item ID (system generated)",
"format": "int32"
},
"Title": {
"maxLength": 500,
"minLength": 1,
"type": "string",
"description": "Cash document item title"
},
"Value": {
"type": "number",
"description": "Cash document item title",
"format": "double"
}
},
"additionalProperties": false,
"description": "Cash document item result object"
},
"APICashDocumentResult": {
"required": [
"CashDocumentId",
"Title",
"Value"
],
"type": "object",
"properties": {
"CashDocumentId": {
"type": "integer",
"description": "Cash document ID (system generated)",
"format": "int32"
},
"TreasuryCode": {
"maxLength": 50,
"type": "string",
"description": "Cash document treasury code",
"nullable": true
},
"CashDocumentType": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocumentTypeEnum"
}
],
"description": "Cash document type\r\n\r\n1 - [Withdrawal] - withdrawal\r\n2 - [Deposit] - deposit \r\n3 - [TempWithdrawal] - temporary withdrawal\r\n4 - [TempDeposit] - temporary deposit\r\n5 - [OpenBalance] - opening balance \r\n\r\nDefault: 1 - [Withdrawal] - withdrawal\n\n1 = Withdrawal\n\n2 = Deposit\n\n3 = TempWithdrawal\n\n4 = TempDeposit\n\n5 = OpenBalance",
"x-enumNames": [
"Withdrawal",
"Deposit",
"TempWithdrawal",
"TempDeposit",
"OpenBalance"
]
},
"Title": {
"maxLength": 500,
"minLength": 1,
"type": "string",
"description": "Cash document title"
},
"Number": {
"maxLength": 100,
"type": "string",
"description": "Cash document number\r\n\r\nOptional - autogenerated by default",
"nullable": true
},
"Value": {
"type": "number",
"description": "Cash document value",
"format": "double"
},
"Date": {
"type": "string",
"description": "Cash document date\r\n\r\nOptional. Default today",
"format": "date-time",
"nullable": true
},
"MadeOutBy": {
"maxLength": 200,
"type": "string",
"description": "Person who made out this cash document\r\n\r\nOptional. Default empty",
"nullable": true
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICashDocumentItemResult"
},
"description": "Cash document items",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Cash documents Notes",
"nullable": true
},
"OperatorType": {
"allOf": [
{
"$ref": "#/components/schemas/APIOperatorTypeEnum"
}
],
"description": "Cash document operator type enum\r\n\r\n1 - [Contractor] - contractor\r\n2 - [Employee] - employee\r\n\r\nDefault: 1 - [Contractor] - contractor\n\n1 = Contractor\n\n2 = Employee",
"x-enumNames": [
"Contractor",
"Employee"
]
},
"OperatorIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIOperatorIdentifierTypeEnum"
}
],
"description": "Operator identifier type\r\n\r\n1 - [TaxID] - Tax ID i.e. NIP\r\n2 - [PersonalID] - Personal ID i.e. PESEL\r\n\r\nDefault: 1 - [TaxID] - Tax ID i.e. NIP\n\n1 = TaxID\n\n2 = PersonalID",
"nullable": true
},
"OperatorIdentifier": {
"maxLength": 50,
"type": "string",
"description": "Operator identifier",
"nullable": true
},
"OperatorName": {
"maxLength": 200,
"type": "string",
"description": "Operator name",
"nullable": true
},
"OperatorAddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Operator address street",
"nullable": true
},
"OperatorAddressCity": {
"maxLength": 200,
"type": "string",
"description": "Operator address city",
"nullable": true
},
"ContractorId": {
"type": "integer",
"description": "Contractor ID (system generated) related with cash document",
"format": "int32",
"nullable": true
},
"EmployeeUserId": {
"type": "integer",
"description": "Employee ID (system generated) related with cash document",
"format": "int32",
"nullable": true
},
"IsAdvanceForEmployee": {
"type": "boolean",
"description": "Is document related with advance payments for employees\r\n\r\nOptional. Default false. \r\nOnly for POWER and above service level."
}
},
"additionalProperties": false,
"description": "Cash document result object"
},
"APICashDocumentResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APICashDocumentResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICashDocumentResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICashDocumentResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICashDocumentTypeEnum": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"description": "Cash document type enum\r\n\r\n1 - [Withdrawal] - withdrawal\r\n2 - [Deposit] - deposit \r\n3 - [TempWithdrawal] - temporary withdrawal\r\n4 - [TempDeposit] - temporary deposit\r\n5 - [OpenBalance] - opening balance\n\n1 = Withdrawal\n\n2 = Deposit\n\n3 = TempWithdrawal\n\n4 = TempDeposit\n\n5 = OpenBalance",
"format": "int32",
"x-enumNames": [
"Withdrawal",
"Deposit",
"TempWithdrawal",
"TempDeposit",
"OpenBalance"
]
},
"APIChartOfAccount": {
"type": "object",
"properties": {
"AccYearId": {
"type": "integer",
"description": "Accounting year ID",
"format": "int32",
"nullable": true
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIChartOfAccountsItem"
},
"description": "Chart of account tree elements",
"nullable": true
},
"RelatedDictionaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIChartOfAccountDictionary"
},
"description": "Chart of account elements from dictionary",
"nullable": true
}
},
"additionalProperties": false,
"description": "Chart of account object"
},
"APIChartOfAccountAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIChartOfAccount"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIChartOfAccountDictionary": {
"type": "object",
"properties": {
"DictionaryId": {
"type": "integer",
"description": "Dictionary ID",
"format": "int32"
},
"AccountId": {
"type": "integer",
"description": "Account ID",
"format": "int32"
},
"AnalyticsNo": {
"type": "integer",
"description": "Analytics number",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Chart of account dictionary object"
},
"APIChartOfAccountsItem": {
"type": "object",
"properties": {
"AccountId": {
"type": "integer",
"description": "Account ID",
"format": "int32",
"nullable": true
},
"ParentAccountId": {
"type": "integer",
"description": "Parent account ID",
"format": "int32"
},
"Account": {
"type": "string",
"description": "Account",
"nullable": true
},
"AccountName": {
"type": "string",
"description": "Account name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Chart of account item object"
},
"APICheckApplicationStatus": {
"enum": [
0,
16,
48,
64
],
"type": "integer",
"description": "Opis:\r\nMożliwe wartości statusów informacji, jakie chcemy przekaząć użytkownikowi\r\n\r\nZmiany:\r\n 2010-02-03 [darek] Utworzenie\r\n 2018-05-14 [staszek] Skopiowanie z ESPClientDataConnector (tam było po nazwą HelloStatusEnum)\r\n\r\nPrzegląd:\n\n0 = None\n\n16 = Stop\n\n48 = Warning\n\n64 = Information",
"format": "int32",
"x-enumNames": [
"None",
"Stop",
"Warning",
"Information"
]
},
"APICheckApplicationStatusInfo": {
"type": "object",
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APICheckApplicationStatus"
}
],
"description": "Status of the user application:\r\nNone = 0, Stop = 16, Warning = 48, Information = 64,\n\n0 = None\n\n16 = Stop\n\n48 = Warning\n\n64 = Information",
"x-enumNames": [
"None",
"Stop",
"Warning",
"Information"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
}
},
"additionalProperties": false,
"description": "User application status info"
},
"APICheckApplicationStatusInfoAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APICheckApplicationStatusInfo"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIContractor": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Name"
},
"IdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Identifier type \r\n\r\n0 - [REGON] - regon (for receivers only)\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n4 - [InternalID] - internal ID (f.ex. KSeF internal number) for receivers only\r\n10 - [NoIdentificationMethod] - no identifier specified (for buyer only)\r\n\r\nDefault: TaxID\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Buyer Identifier\r\nType based on IdentifierType",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City and postal code",
"nullable": true
},
"AddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"CountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"Email": {
"maxLength": 200,
"type": "string",
"description": "E-mail",
"nullable": true
},
"Phone": {
"maxLength": 30,
"type": "string",
"description": "Phone",
"nullable": true
},
"MobilePhone": {
"maxLength": 30,
"type": "string",
"description": "Mobile phone",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"GlobalLocationNumber": {
"type": "string",
"description": "Global Location Number (GLN)",
"nullable": true
},
"VATProcedures": {
"type": "array",
"items": {
"type": "string"
},
"description": "VAT Procedures",
"nullable": true
},
"Discount": {
"type": "number",
"description": "Percentage discount",
"format": "double",
"nullable": true
},
"DiscountNote": {
"type": "string",
"description": "Discount note or null/empty",
"nullable": true
},
"InvoicingNote": {
"type": "string",
"description": "A note to the invoicing process",
"nullable": true
},
"ShowInvoicingNote": {
"type": "boolean",
"description": "True - A note to the invoicing process will be displayed \r\nDefault: false",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contractor object"
},
"APIContractorIndentifierType": {
"enum": [
0,
1,
2,
3,
4,
10
],
"type": "integer",
"description": "Type of contractor identifaction:\r\n\r\n0 - [REGON] - regon (for receivers only)\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n4 - [InternalID] - internal ID (f.ex. KSeF internal number) for receivers only\r\n10 - [NoIdentificationMethod] - no identifier specified (for buyer only)\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"format": "int32",
"x-enumNames": [
"REGON",
"TaxID",
"PersonalID",
"Other",
"InternalID",
"NoIdentificationMethod"
]
},
"APIContractorReceiverType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Receiver type \r\n\r\n0 - [Standard] - Standard receiver\r\n1 - [JST] - JST receiver\r\n2 - [VatGroup] - VAT group receiver\r\n3 - [RoleOther] - Other role receiver\n\n0 = Standard\n\n1 = JST\n\n2 = VatGroup\n\n3 = RoleOther",
"format": "int32",
"x-enumNames": [
"Standard",
"JST",
"VatGroup",
"RoleOther"
]
},
"APIContractorResult": {
"required": [
"Name"
],
"type": "object",
"properties": {
"ContractorId": {
"type": "integer",
"description": "Contractor ID",
"format": "int32"
},
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Name"
},
"IdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Identifier type \r\n\r\n0 - [REGON] - regon (for receivers only)\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n4 - [InternalID] - internal ID (f.ex. KSeF internal number) for receivers only\r\n10 - [NoIdentificationMethod] - no identifier specified (for buyer only)\r\n\r\nDefault: TaxID\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Buyer Identifier\r\nType based on IdentifierType",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City and postal code",
"nullable": true
},
"AddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"CountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"Email": {
"maxLength": 200,
"type": "string",
"description": "E-mail",
"nullable": true
},
"Phone": {
"maxLength": 30,
"type": "string",
"description": "Phone",
"nullable": true
},
"MobilePhone": {
"maxLength": 30,
"type": "string",
"description": "Mobile phone",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"GlobalLocationNumber": {
"type": "string",
"description": "Global Location Number (GLN)",
"nullable": true
},
"VATProcedures": {
"type": "array",
"items": {
"type": "string"
},
"description": "VAT Procedures",
"nullable": true
},
"Discount": {
"type": "number",
"description": "Percentage discount",
"format": "double",
"nullable": true
},
"DiscountNote": {
"type": "string",
"description": "Discount note or null/empty",
"nullable": true
},
"InvoicingNote": {
"type": "string",
"description": "A note to the invoicing process",
"nullable": true
},
"ShowInvoicingNote": {
"type": "boolean",
"description": "True - A note to the invoicing process will be displayed \r\nDefault: false",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contractor object"
},
"APIContractorResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIContractorResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIContractorResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICountry": {
"type": "object",
"properties": {
"CountryName": {
"type": "string",
"description": "Country name",
"nullable": true
},
"CountryEN": {
"type": "string",
"description": "Country name in english",
"nullable": true
},
"CountryCode": {
"type": "string",
"description": "Country code",
"nullable": true
}
},
"additionalProperties": false,
"description": "Country"
},
"APICountryIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICountry"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICustomDictionaryItem": {
"type": "object",
"properties": {
"CustomDictionaryId": {
"type": "integer",
"description": "Custom dictionary Id",
"format": "int32",
"nullable": true
},
"Name": {
"type": "string",
"description": "Custom dictionary item name",
"nullable": true
},
"Key": {
"type": "string",
"description": "Custom dictionary item key",
"nullable": true
},
"SearchTexts": {
"type": "string",
"description": "Text to be searched in OCR - separated by a semicolon. Note - Name and Key values are not searched!",
"nullable": true
},
"SearchRegex": {
"type": "string",
"description": "Regex used for searching - regex is used first if it is filled in at the same time as SearchTexts",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"ContractorTaxId": {
"type": "string",
"description": "Contractor TaxID",
"nullable": true
},
"ContractorNameMask": {
"type": "string",
"description": "Contractor name mask",
"nullable": true
},
"Tag1": {
"type": "string",
"description": "Tag name for classification 1 (UnpackTagsMode)",
"nullable": true
},
"Tag2": {
"type": "string",
"description": "Tag name for classification 2 (UnpackTagsMode)",
"nullable": true
},
"Tag3": {
"type": "string",
"description": "Tag name for classification 3 (UnpackTagsMode)",
"nullable": true
},
"Tag4": {
"type": "string",
"description": "Tag name for classification 4 (UnpackTagsMode)",
"nullable": true
},
"Tag5": {
"type": "string",
"description": "Tag name for classification 5 (UnpackTagsMode)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom dictionary item"
},
"APICustomDictionaryItemResult": {
"type": "object",
"properties": {
"CustomDictionaryItemId": {
"type": "integer",
"description": "Custom dictionary item Id",
"format": "int32"
},
"CustomDictionaryId": {
"type": "integer",
"description": "Custom dictionary Id",
"format": "int32",
"nullable": true
},
"Name": {
"type": "string",
"description": "Custom dictionary item name",
"nullable": true
},
"Key": {
"type": "string",
"description": "Custom dictionary item key",
"nullable": true
},
"SearchTexts": {
"type": "string",
"description": "Text to be searched in OCR - separated by a semicolon. Note - Name and Key values are not searched!",
"nullable": true
},
"SearchRegex": {
"type": "string",
"description": "Regex used for searching - regex is used first if it is filled in at the same time as SearchTexts",
"nullable": true
},
"TagId": {
"type": "integer",
"description": "Tag Id - Only for items from dictionaries of type: TagBased",
"format": "int32",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"ContractorTaxId": {
"type": "string",
"description": "Contractor TaxID",
"nullable": true
},
"ContractorNameMask": {
"type": "string",
"description": "Contractor name mask",
"nullable": true
},
"Tag1": {
"type": "string",
"description": "Tag name for classification 1 (UnpackTagsMode)",
"nullable": true
},
"Tag2": {
"type": "string",
"description": "Tag name for classification 2 (UnpackTagsMode)",
"nullable": true
},
"Tag3": {
"type": "string",
"description": "Tag name for classification 3 (UnpackTagsMode)",
"nullable": true
},
"Tag4": {
"type": "string",
"description": "Tag name for classification 4 (UnpackTagsMode)",
"nullable": true
},
"Tag5": {
"type": "string",
"description": "Tag name for classification 5 (UnpackTagsMode)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom dictionary item result"
},
"APICustomDictionaryItemResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APICustomDictionaryItemResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICustomDictionaryItemResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICustomDictionaryItemResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICustomDictionaryResult": {
"type": "object",
"properties": {
"CustomDictionaryId": {
"type": "integer",
"description": "Custom dictionary Id",
"format": "int32"
},
"Name": {
"type": "string",
"description": "Custom dictionary name",
"nullable": true
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APICustomDictionaryType"
}
],
"description": "Custom dictionary type:\r\n\r\n0 - [Standard] - Standard dictionary with items\r\n5 - [TagBased] - Dictionary items based on tags\r\n9 - [NoItemsOnlyRegex] - Dictionary based on regex\r\n20 - [CarRegistrationSearcher] - Finds car registration\r\n50 - [UnitValues] - Gets the value of the selected unit\r\n60 - [ContractorBased] - Dictionary items related with contractors - finds their elements\r\n70 - [UnpackTagsMode] - Dictionary for unpacking items into multiple tag classifications\n\n0 = Standard\n\n5 = TagBased\n\n9 = NoItemsOnlyRegex\n\n20 = CarRegistrationSearcher\n\n50 = UnitValues\n\n60 = ContractorBased\n\n70 = UnpackTagsMode",
"x-enumNames": [
"Standard",
"TagBased",
"NoItemsOnlyRegex",
"CarRegistrationSearcher",
"UnitValues",
"ContractorBased",
"UnpackTagsMode"
]
},
"SearchAfterDigitalization": {
"type": "boolean",
"description": "Should there be a search for elements of this dictionary after the digitizing process - the dictionary must be connected to some used custom field in the document. Notice, overwrites previous values."
},
"SearchInDocumentNotes": {
"type": "boolean",
"description": "Should the dictionary be used to search the document note. Notice, overwrites previous values including those after digitalization."
},
"SearchOnlyOneValue": {
"type": "boolean",
"description": "Determines how the value is set during a search.\r\nIf true, the value will be set only if the search returns exactly one result.\r\nIf false, the value will be set based on the first matching result found."
},
"Notes": {
"type": "string",
"description": "Notes",
"nullable": true
},
"UnpackTagsMode_IDTagClassification_1": {
"type": "integer",
"description": "Tag classification ID 1 (for UnpackTagsMode dictionary type)",
"format": "int32",
"nullable": true
},
"UnpackTagsMode_IDTagClassification_2": {
"type": "integer",
"description": "Tag classification ID 2 (for UnpackTagsMode dictionary type)",
"format": "int32",
"nullable": true
},
"UnpackTagsMode_IDTagClassification_3": {
"type": "integer",
"description": "Tag classification ID 3 (for UnpackTagsMode dictionary type)",
"format": "int32",
"nullable": true
},
"UnpackTagsMode_IDTagClassification_4": {
"type": "integer",
"description": "Tag classification ID 4 (for UnpackTagsMode dictionary type)",
"format": "int32",
"nullable": true
},
"UnpackTagsMode_IDTagClassification_5": {
"type": "integer",
"description": "Tag classification ID 5 (for UnpackTagsMode dictionary type)",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom dictionary object"
},
"APICustomDictionaryResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APICustomDictionaryResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICustomDictionaryResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICustomDictionaryResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APICustomDictionaryType": {
"enum": [
0,
5,
9,
20,
50,
60,
70
],
"type": "integer",
"description": "Custom dictionary type:\r\n\r\n0 - [Standard] - Standard dictionary with items\r\n5 - [TagBased] - Dictionary items based on tags\r\n9 - [NoItemsOnlyRegex] - Dictionary based on regex\r\n20 - [CarRegistrationSearcher] - Finds car registration\r\n50 - [UnitValues] - Gets the value of the selected unit\r\n60 - [ContractorBased] - Dictionary items related with contractors - finds their elements\r\n70 - [UnpackTagsMode] - Dictionary for unpacking items into multiple tag classifications\n\n0 = Standard\n\n5 = TagBased\n\n9 = NoItemsOnlyRegex\n\n20 = CarRegistrationSearcher\n\n50 = UnitValues\n\n60 = ContractorBased\n\n70 = UnpackTagsMode",
"format": "int32",
"x-enumNames": [
"Standard",
"TagBased",
"NoItemsOnlyRegex",
"CarRegistrationSearcher",
"UnitValues",
"ContractorBased",
"UnpackTagsMode"
]
},
"APICustomField": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "Field key",
"nullable": true
},
"Name": {
"type": "string",
"description": "Field name",
"nullable": true
},
"Value": {
"description": "Field value",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom field"
},
"APICustomerDataInfo": {
"type": "object",
"properties": {
"CustomerName": {
"type": "string",
"description": "nazwa klienta",
"nullable": true
},
"NIP": {
"type": "string",
"description": "NIP",
"nullable": true
},
"HouseNo": {
"type": "string",
"description": "Numer domu",
"nullable": true
},
"FlatNo": {
"type": "string",
"description": "Numer mieszkania",
"nullable": true
},
"Street": {
"type": "string",
"description": "Ulica",
"nullable": true
},
"City": {
"type": "string",
"description": "Miasto",
"nullable": true
},
"PostCode": {
"type": "string",
"description": "Kod pocztowy",
"nullable": true
},
"Country": {
"type": "string",
"description": "Kraj",
"nullable": true
}
},
"additionalProperties": false,
"description": "Opis:\r\n Dane klienta Taxxo uzywane w API (np wizytowka)\r\n \r\nPowiazania:\r\n API / aplikacja mobilna / wizytówka\r\n \r\nModyfikacje:\r\n 2019-02-20 PaS - opisanie"
},
"APICustomerServiceLevel": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
-1
],
"type": "integer",
"description": "Customer service level:\r\n\r\n-1 - [None] - Lack of any services\r\n0 - [Mini] - Free package (clients without an office) - with limits\r\n1 - [Start] - Start package (free for office clients) - with limits\r\n2 - [Standard] - Standard package\r\n3 - [Premium] - Premium package\r\n4 - [Power] - Power package\r\n5 - [Ultra] - Ultra package\r\n6 - [Ultimate] - Ultimate package\n\n0 = Mini\n\n1 = Start\n\n2 = Standard\n\n3 = Premium\n\n4 = Power\n\n5 = Ultra\n\n6 = Ultimate\n\n-1 = None",
"format": "int32",
"x-enumNames": [
"Mini",
"Start",
"Standard",
"Premium",
"Power",
"Ultra",
"Ultimate",
"None"
]
},
"APICycleCostMissingDocument": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Contractor name",
"nullable": true
},
"Identifier": {
"type": "string",
"description": "Contractor TaxID",
"nullable": true
},
"DocumentExpectedDate": {
"type": "string",
"description": "Date of expected document",
"format": "date-time"
},
"DocumentsCount": {
"type": "integer",
"description": "Number of documents",
"format": "int32"
},
"ExpectedNet": {
"type": "number",
"description": "Expected net amount",
"format": "double",
"nullable": true
},
"ExpectedTax": {
"type": "number",
"description": "Expected VAT",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Cycle cost missing document"
},
"APICycleCostMissingDocumentIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICycleCostMissingDocument"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDatePresentationTypeEnum": {
"enum": [
1,
2
],
"type": "integer",
"description": "Date presentation type:\r\n\r\n1 - [FullDate] - Full date \r\n2 - [MonthYear] - Only year and month from date\n\n1 = FullDate\n\n2 = MonthYear",
"format": "int32",
"x-enumNames": [
"FullDate",
"MonthYear"
]
},
"APIDictionaryPaymentEventType": {
"type": "object",
"properties": {
"PaymentEventTypeName": {
"type": "string",
"description": "Payment event type name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payment event type (the event triggering the payment of the invoice)"
},
"APIDictionaryPaymentEventTypeIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDictionaryPaymentEventType"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDictionaryPaymentForm": {
"type": "object",
"properties": {
"PaymentFormName": {
"type": "string",
"description": "Payment form name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payment form"
},
"APIDictionaryPaymentFormIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDictionaryPaymentForm"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDigitalizationProblem": {
"type": "object",
"properties": {
"ProblemMessage": {
"type": "string",
"description": "Digitalization problem message",
"nullable": true
},
"ProblemRelatesAmounts": {
"type": "boolean",
"description": "Whether the digitalization problem relates to the amounts\r\n\r\nDefault: false"
}
},
"additionalProperties": false,
"description": "Digitalization problem object"
},
"APIDirectionEnum": {
"enum": [
1,
-1
],
"type": "integer",
"description": "Direction API global enum\r\n\r\n-1 - [Cost] - cost\r\n 1 - [Income] - income\n\n1 = Income\n\n-1 = Cost",
"format": "int32",
"x-enumNames": [
"Income",
"Cost"
]
},
"APIDiscountType": {
"enum": [
0,
1
],
"type": "integer",
"description": "Type of discount given on items\r\n\r\n0 - [Percent] - Discount in percent\r\n1 - [Amount] - Discount in amount\n\n0 = Percent\n\n1 = Amount",
"format": "int32",
"x-enumNames": [
"Percent",
"Amount"
]
},
"APIDocument": {
"type": "object",
"properties": {
"FileDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentFileDetails"
}
],
"description": "Scanned file details",
"nullable": true
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"ContractorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentContractorDetails"
}
],
"description": "Contractor details (i.e. name, taxID, adress)",
"nullable": true
},
"TaxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTaxLine"
},
"description": "Summary of document's VAT calculations (in every VAT rate)",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentCurrencyDetails"
}
],
"description": "Document currency, rates, etc.",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPaymentDetails"
}
],
"description": "Payment details",
"nullable": true
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"ReimbursementDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentReimbursementDetails"
}
],
"description": "Reimbursement details.\r\n\r\nOnly for POWER and above service level.",
"nullable": true
},
"OwnedByDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentOwnedByDetails"
}
],
"description": "Owned by details.\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
},
"TargetToDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentTargetToDetails"
}
],
"description": "Section that provides functionality to add documents to different customer on the Platform.\r\nLeave empty if adding document to Your account.\r\n\r\nExtended permission required. For more information contact us at api@taxxo.app.",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetailsWithKey"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document (add or modify operation)"
},
"APIDocumentAcceptanceRule": {
"type": "object",
"properties": {
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tag names defining the rule scope",
"nullable": true
},
"AllowAll": {
"type": "boolean",
"description": "Whether the rule applies to all documents regardless of tags.\r\nIf true - tags and WithoutTagsFromGroupId fields are ignored."
},
"WithoutTagsFromGroupId": {
"type": "integer",
"description": "ID of the tag group used to match documents without any tag from that group.\r\n(UI equivalent: \"Bez tagu z grupy\")\r\nCan be combined with Tags.",
"format": "int32",
"nullable": true
},
"Modules": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of module IDs that the rule applies to.\r\nAllowed values: 15 (EInvoice), 16 (ESourceDocuments).\r\nPass [15, 16] for both modules. Null or empty also means both modules.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document acceptance rule - controls which documents a user can accept (input).\r\nUsed with POST /user/{userId}/permissions/documentAcceptanceRules/{orgStructureId}\r\nThe orgStructureId is provided via URL path, not in the request body."
},
"APIDocumentAcceptanceRuleResult": {
"type": "object",
"properties": {
"UniqueKey": {
"type": "string",
"description": "Unique key identifying this rule.\r\nUsed as identifier when removing the rule via DELETE endpoint.",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tag names defining the rule scope",
"nullable": true
},
"AllowAll": {
"type": "boolean",
"description": "Whether the rule applies to all documents regardless of tags.\r\nIf true - tags and WithoutTagsFromGroupId fields are ignored."
},
"WithoutTagsFromGroupId": {
"type": "integer",
"description": "ID of the tag group used to match documents without any tag from that group.\r\n(UI equivalent: \"Bez tagu z grupy\")\r\nCan be combined with Tags.",
"format": "int32",
"nullable": true
},
"Modules": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of module IDs that the rule applies to.\r\nAllowed values: 15 (EInvoice), 16 (ESourceDocuments).\r\nPass [15, 16] for both modules. Null or empty also means both modules.",
"nullable": true
},
"OrgStructureId": {
"type": "integer",
"description": "Organization structure ID that this acceptance rule is scoped to.\r\nAcceptance rules are always linked to a specific organization structure.",
"format": "int32",
"nullable": true
},
"OrgStructureName": {
"type": "string",
"description": "Organization structure name (read-only, resolved from OrgStructureId)",
"nullable": true
},
"InheritedFrom": {
"type": "string",
"description": "Name of the user group from which the rule was inherited.\r\nNull means the rule was assigned directly to the user.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document acceptance rule (output).\r\nReturned by GET /user/{userId}/permissions/documentAcceptanceRules/{orgStructureId}"
},
"APIDocumentAcceptanceRuleResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentAcceptanceRuleResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentAccessRule": {
"type": "object",
"properties": {
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tag names defining the rule scope",
"nullable": true
},
"AllowAll": {
"type": "boolean",
"description": "Whether the rule applies to all documents regardless of tags.\r\nIf true - tags and WithoutTagsFromGroupId fields are ignored."
},
"WithoutTagsFromGroupId": {
"type": "integer",
"description": "ID of the tag group used to match documents without any tag from that group.\r\n(UI equivalent: \"Bez tagu z grupy\")\r\nCan be combined with Tags.",
"format": "int32",
"nullable": true
},
"Modules": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of module IDs that the rule applies to.\r\nAllowed values: 15 (EInvoice), 16 (ESourceDocuments).\r\nPass [15, 16] for both modules. Null or empty also means both modules.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document access rule - controls which documents a user can see (input).\r\nUsed with POST /user/{userId}/permissions/documentAccessRules"
},
"APIDocumentAccessRuleResult": {
"type": "object",
"properties": {
"UniqueKey": {
"type": "string",
"description": "Unique key identifying this rule.\r\nUsed as identifier when removing the rule via DELETE endpoint.",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tag names defining the rule scope",
"nullable": true
},
"AllowAll": {
"type": "boolean",
"description": "Whether the rule applies to all documents regardless of tags.\r\nIf true - tags and WithoutTagsFromGroupId fields are ignored."
},
"WithoutTagsFromGroupId": {
"type": "integer",
"description": "ID of the tag group used to match documents without any tag from that group.\r\n(UI equivalent: \"Bez tagu z grupy\")\r\nCan be combined with Tags.",
"format": "int32",
"nullable": true
},
"Modules": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of module IDs that the rule applies to.\r\nAllowed values: 15 (EInvoice), 16 (ESourceDocuments).\r\nPass [15, 16] for both modules. Null or empty also means both modules.",
"nullable": true
},
"InheritedFrom": {
"type": "string",
"description": "Name of the user group from which the rule was inherited.\r\nNull means the rule was assigned directly to the user.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document access rule (output).\r\nReturned by GET /user/{userId}/permissions/documentAccessRules"
},
"APIDocumentAccessRuleResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentAccessRuleResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentAccountingData": {
"type": "object",
"properties": {
"DocumentId": {
"type": "integer",
"description": "Document ID (internal)",
"format": "int32"
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"AccountingLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIAccountingLineBasedOnTags"
},
"description": "Ledger line based on tags (lines)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document accounting data - standard details and accounts based on tags and rules"
},
"APIDocumentAccountingDataAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentAccountingData"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentAnalysisByTagGroupResult": {
"type": "object",
"properties": {
"DocumentId": {
"type": "integer",
"description": "Document ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"StatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusDetails"
}
],
"description": "Document statuses details",
"nullable": true
},
"ContractorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentContractorDetails"
}
],
"description": "Contractor details (i.e. name, taxID, adress)",
"nullable": true
},
"TaxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTaxLine"
},
"description": "Summary of document's VAT calculations (in every VAT rate)",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentCurrencyDetails"
}
],
"description": "Document currency, rates, etc.",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPaymentDetails"
}
],
"description": "Payment details",
"nullable": true
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"DigitalizationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDigitalizationDetails"
}
],
"description": "Document digitalization details",
"nullable": true
},
"ReimbursementDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentReimbursementDetails"
}
],
"description": "Reimbursement details.\r\n\r\nOnly for POWER and above service level.",
"nullable": true
},
"OwnedByDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentOwnedByDetails"
}
],
"description": "Owned by details.\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
},
"VATStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentVATStatusDetails"
}
],
"description": "Details of contractor VAT Status (if checked)",
"nullable": true
},
"BankAccountStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentBankAccountStatusDetails"
}
],
"description": "Details of Bank Account status (if checked on whitelist)",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AdditionalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AdditionalDetails"
}
],
"description": "Additional details section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"KsefDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentKsefDetails"
}
],
"description": "Details of KSeF",
"nullable": true
},
"AllocationByTag": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationByTag"
}
],
"description": "Allocation by tag section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document analysis by tag group (result operation)"
},
"APIDocumentAnalysisByTagGroupResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentAnalysisByTagGroupResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentAnalysisResult": {
"type": "object",
"properties": {
"DocumentId": {
"type": "integer",
"description": "Document ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"StatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusDetails"
}
],
"description": "Document statuses details",
"nullable": true
},
"ContractorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentContractorDetails"
}
],
"description": "Contractor details (i.e. name, taxID, adress)",
"nullable": true
},
"TaxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTaxLine"
},
"description": "Summary of document's VAT calculations (in every VAT rate)",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentCurrencyDetails"
}
],
"description": "Document currency, rates, etc.",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPaymentDetails"
}
],
"description": "Payment details",
"nullable": true
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"DigitalizationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDigitalizationDetails"
}
],
"description": "Document digitalization details",
"nullable": true
},
"ReimbursementDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentReimbursementDetails"
}
],
"description": "Reimbursement details.\r\n\r\nOnly for POWER and above service level.",
"nullable": true
},
"OwnedByDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentOwnedByDetails"
}
],
"description": "Owned by details.\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
},
"VATStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentVATStatusDetails"
}
],
"description": "Details of contractor VAT Status (if checked)",
"nullable": true
},
"BankAccountStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentBankAccountStatusDetails"
}
],
"description": "Details of Bank Account status (if checked on whitelist)",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AdditionalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AdditionalDetails"
}
],
"description": "Additional details section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"KsefDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentKsefDetails"
}
],
"description": "Details of KSeF",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document analysis (result operation)"
},
"APIDocumentAnalysisResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentAnalysisResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentDigitalizationStatus": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"description": "Digitalization status:\r\n\r\n1 - [NotToDigitalization] - Do not digitalize\r\n2 - [AwaitingDigitalization] - Awaiting for digitalization service (prosessing not started yet)\r\n3 - [SentToDigitalization] - Sent to digitalization service (in processing)\r\n4 - [Digitalized] - Done\r\n5 - [Error] - Error after digitalization\r\n6 - [Canceled] - Digitalization canceled\r\n7 - [ToVerification] - Document need to be verify after digitalization\r\n8 - [None] - None\n\n1 = NotToDigitalization\n\n2 = AwaitingDigitalization\n\n3 = SentToDigitalization\n\n4 = Digitalized\n\n5 = Error\n\n6 = Canceled\n\n7 = ToVerification\n\n8 = None",
"format": "int32",
"x-enumNames": [
"NotToDigitalization",
"AwaitingDigitalization",
"SentToDigitalization",
"Digitalized",
"Error",
"Canceled",
"ToVerification",
"None"
]
},
"APIDocumentDirectionType": {
"enum": [
0,
1,
-1
],
"type": "integer",
"description": "Direction type\r\n\r\n-1 - [Costs] - Costs\r\n0 - [Unknown] - Unknown\r\n1 - [Revenues] - Revenues\n\n0 = Unknown\n\n1 = Revenues\n\n-1 = Costs",
"format": "int32",
"x-enumNames": [
"Unknown",
"Revenues",
"Costs"
]
},
"APIDocumentFlagColor": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"description": "Flag color:\r\n\r\n0 - [NoFlag] - no flag\r\n1 - [Red] - red color\r\n2 - [Orange] - orange color\r\n3 - [Yellow] - yellow color\r\n4 - [Green] - green color\r\n5 - [Violet] - violet color\r\n6 - [Blue] - blue color\r\n7 - [Pink] - pink color\n\n0 = NoFlag\n\n1 = Red\n\n2 = Orange\n\n3 = Yellow\n\n4 = Green\n\n5 = Violet\n\n6 = Blue\n\n7 = Pink",
"format": "int32",
"x-enumNames": [
"NoFlag",
"Red",
"Orange",
"Yellow",
"Green",
"Violet",
"Blue",
"Pink"
]
},
"APIDocumentKSeFImportRequest": {
"type": "object",
"properties": {
"Xml": {
"type": "string",
"description": "Raw invoice XML.",
"nullable": true
},
"KsefNumber": {
"type": "string",
"description": "KSeF invoice number (reference number).",
"nullable": true
},
"KsefDate": {
"type": "string",
"description": "Date/time when invoice was added to KSeF.",
"format": "date-time"
},
"DocumentID": {
"type": "string",
"description": "External document identifier",
"nullable": true
},
"OwnerNIP": {
"type": "string",
"description": "Owner company NIP.",
"nullable": true
},
"KsefCertificateLink": {
"type": "string",
"description": "KSeF certificate link",
"nullable": true
},
"Direction": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentDirectionType"
}
],
"description": "Document direction\r\n-1 = Costs (default)\r\n1 = Revenues\n\n0 = Unknown\n\n1 = Revenues\n\n-1 = Costs",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for importing a KSeF invoice from XML via Public API."
},
"APIDocumentKsefStatus": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "Document KSeF status:\r\n\r\n0 - [NotApplicable] - not apply to KSeF\r\n1 - [KsefXMLInvoiceDirect] - KSeF invoice, based on KSeF XML\r\n1 - [KsefPDFInvoiceOnline] - KSeF invoice online, identified based on PDF\r\n2 - [KsefPDFInvoiceOffline] - KSeF invoice offline, identified based on PDF\r\n3 - [KsefRelatedDocument] - document related to KSeF invoice\n\n0 = NotApplicable\n\n1 = KsefXMLInvoiceDirect\n\n2 = KsefPDFInvoiceOnline\n\n3 = KsefPDFInvoiceOffline\n\n4 = KsefRelatedDocument",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"KsefXMLInvoiceDirect",
"KsefPDFInvoiceOnline",
"KsefPDFInvoiceOffline",
"KsefRelatedDocument"
]
},
"APIDocumentPaidStatus": {
"enum": [
0,
1,
2,
-1
],
"type": "integer",
"description": "Payment status:\r\n\r\n-1 - [Unknown] - Not set yet (default)\r\n0 - [IsPaidNo] - Not paid\r\n1 - [IsPaidYes] - Paid\r\n2 - [IsPaidNotApplicable] - Not applicable to this document (i.e. Agreement)\n\n0 = IsPaidNo\n\n1 = IsPaidYes\n\n2 = IsPaidNotApplicable\n\n-1 = Unknown",
"format": "int32",
"x-enumNames": [
"IsPaidNo",
"IsPaidYes",
"IsPaidNotApplicable",
"Unknown"
]
},
"APIDocumentPaymentDecisionStatus": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"description": "Payment decision made to this document:\r\n\r\n1 - [PaymentWaiting] - Payment waiting (default)\r\n2 - [PaymentAccepted] - Accepted\r\n3 - [PaymentSuspended] - Suspended\r\n4 - [PaymentToClarify] - Something is wrong\r\n5 - [PaymentSentToBank] - Waiting in bank to be accepted or processed\n\n1 = PaymentWaiting\n\n2 = PaymentAccepted\n\n3 = PaymentSuspended\n\n4 = PaymentToClarify\n\n5 = PaymentSentToBank",
"format": "int32",
"x-enumNames": [
"PaymentWaiting",
"PaymentAccepted",
"PaymentSuspended",
"PaymentToClarify",
"PaymentSentToBank"
]
},
"APIDocumentPosition": {
"type": "object",
"properties": {
"OrdinalNumber": {
"type": "integer",
"description": "Ordinal number",
"format": "int32",
"nullable": true
},
"ItemName": {
"type": "string",
"description": "Item name",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"Unit": {
"type": "string",
"description": "Unit",
"nullable": true
},
"NetPrice": {
"type": "number",
"description": "Net price",
"format": "double",
"nullable": true
},
"TaxRate": {
"type": "string",
"description": "Tax rate - percent or text label (like RC)",
"nullable": true
},
"TotalNet": {
"type": "number",
"description": "Total net price",
"format": "double",
"nullable": true
},
"TotalTaxValue": {
"type": "number",
"description": "Total tax value (VAT)",
"format": "double",
"nullable": true
},
"TotalGross": {
"type": "number",
"description": "Total gross price",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document's position"
},
"APIDocumentProcessingStatus": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Status of external processing of document after digitalization:\r\n\r\n1 - [NotReady] - Not ready yet - digitalization in progress\r\n2 - [Ready] - Ready to process\r\n3 - [Processed] - Already processed\n\n1 = NotReady\n\n2 = Ready\n\n3 = Processed",
"format": "int32",
"x-enumNames": [
"NotReady",
"Ready",
"Processed"
]
},
"APIDocumentResult": {
"type": "object",
"properties": {
"DocumentId": {
"type": "integer",
"description": "Document ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"StatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusDetails"
}
],
"description": "Document statuses details",
"nullable": true
},
"ContractorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentContractorDetails"
}
],
"description": "Contractor details (i.e. name, taxID, adress)",
"nullable": true
},
"TaxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTaxLine"
},
"description": "Summary of document's VAT calculations (in every VAT rate)",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentCurrencyDetails"
}
],
"description": "Document currency, rates, etc.",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPaymentDetails"
}
],
"description": "Payment details",
"nullable": true
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"DigitalizationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDigitalizationDetails"
}
],
"description": "Document digitalization details",
"nullable": true
},
"ReimbursementDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentReimbursementDetails"
}
],
"description": "Reimbursement details.\r\n\r\nOnly for POWER and above service level.",
"nullable": true
},
"OwnedByDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentOwnedByDetails"
}
],
"description": "Owned by details.\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
},
"VATStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentVATStatusDetails"
}
],
"description": "Details of contractor VAT Status (if checked)",
"nullable": true
},
"BankAccountStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentBankAccountStatusDetails"
}
],
"description": "Details of Bank Account status (if checked on whitelist)",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"KsefDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentKsefDetails"
}
],
"description": "Details of KSeF",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document (result operation)"
},
"APIDocumentResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentResultOne": {
"type": "object",
"properties": {
"DocumentId": {
"type": "integer",
"description": "Document ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"StatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusDetails"
}
],
"description": "Document statuses details",
"nullable": true
},
"ContractorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentContractorDetails"
}
],
"description": "Contractor details (i.e. name, taxID, adress)",
"nullable": true
},
"TaxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTaxLine"
},
"description": "Summary of document's VAT calculations (in every VAT rate)",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentCurrencyDetails"
}
],
"description": "Document currency, rates, etc.",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPaymentDetails"
}
],
"description": "Payment details",
"nullable": true
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"DigitalizationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDigitalizationDetails"
}
],
"description": "Document digitalization details",
"nullable": true
},
"ReimbursementDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentReimbursementDetails"
}
],
"description": "Reimbursement details.\r\n\r\nOnly for POWER and above service level.",
"nullable": true
},
"OwnedByDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentOwnedByDetails"
}
],
"description": "Owned by details.\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
},
"VATStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentVATStatusDetails"
}
],
"description": "Details of contractor VAT Status (if checked)",
"nullable": true
},
"BankAccountStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentBankAccountStatusDetails"
}
],
"description": "Details of Bank Account status (if checked on whitelist)",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"Positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentPosition"
},
"description": "Document's positions",
"nullable": true
},
"KsefDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentKsefDetails"
}
],
"description": "Details of KSeF",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document (result operation) return by a method that returns a single object"
},
"APIDocumentResultOneAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentResultOne"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentStatus": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
9,
10,
11,
13,
14,
15
],
"type": "integer",
"description": "Document status\r\n\r\n1 - [ForAcceptation] - Need acceptation (Accounting office couldn't see this document)\r\n2 - [ForBook] - Ready for booking\r\n3 - [ForBookChanged] - Need booking - document has changed\r\n4 - [Booked] - Booked\r\n5 - [ForBookForWithdrawn] - To withdraw by accounting office\r\n6 - [Withdrawn] - Withdrawn / deleted\r\n7 - [NotAccepted] - Not accepted / rejected\r\n9 - [BookedChanged] - Booked, but has change after that\r\n10 - [Deleted] - Deleted\r\n11 - [Returned] - Returned\r\n13 - [BookedForWithdrawn] - Booked, but user asked for withdraw\r\n14 - [WithdrawnByDigitalization] - Withdrawn by digitalization process (i.e. duplicate)\r\n15 - [ForVerification] - Need Verification (after OCR process)\n\n1 = ForAcceptation\n\n2 = ForBook\n\n3 = ForBookChanged\n\n4 = Booked\n\n5 = ForBookForWithdrawn\n\n6 = Withdrawn\n\n7 = NotAccepted\n\n9 = BookedChanged\n\n10 = Deleted\n\n11 = Returned\n\n13 = BookedForWithdrawn\n\n14 = WithdrawnByDigitalization\n\n15 = ForVerification",
"format": "int32",
"x-enumNames": [
"ForAcceptation",
"ForBook",
"ForBookChanged",
"Booked",
"ForBookForWithdrawn",
"Withdrawn",
"NotAccepted",
"BookedChanged",
"Deleted",
"Returned",
"BookedForWithdrawn",
"WithdrawnByDigitalization",
"ForVerification"
]
},
"APIDocumentTaxLine": {
"type": "object",
"properties": {
"OrdinalNumber": {
"type": "integer",
"description": "Ordinal",
"format": "int32",
"nullable": true
},
"TaxRate": {
"maxLength": 50,
"type": "string",
"description": "Tax rate - percent or text label (i.e. RC)",
"nullable": true
},
"NetValue": {
"type": "number",
"description": "Net value (without VAT)",
"format": "double",
"nullable": true
},
"TaxValue": {
"type": "number",
"description": "Tax value (VAT)",
"format": "double",
"nullable": true
},
"GrossValue": {
"type": "number",
"description": "Gross value (with VAT)",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document's tax summary line"
},
"APIDocumentType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
-500
],
"type": "integer",
"description": "Document type:\r\n\r\n1 - [SalesInvoice] - Sales invoice\r\n2 - [PurchaseInvoice] - Purchase invoice\r\n3 - [SalesReceipt] - Sales receipt\r\n4 - [PurchaseReceipt] - Purchase receipt\r\n5 - [BankStatement] - Bank statement\r\n6 - [Declaration] - Declaration (i.e. Tax Declaration or SAD)\r\n7 - [CashDocument] - Cash statement \r\n8 - [CivilContract] - Civil contract\r\n9 - [Payroll] - Payroll\r\n10 - [OtherDocument] - Other (any)\r\n11 - [PurchaseInvoiceCorrection] - Purchase invoice correction\r\n12 - [InterestNote] - Interests\r\n13 - [Delegation] - Delegation / business trip\r\n14 - [SalesInvoiceCorrection] - Sales invoice correction\r\n15 - [PersonnelDocument] - HR document\r\n16 - [WorkContract] - Work Contract (HR)\r\n17 - [WorkOfMandate] - Work of Mandate (HR)\r\n18 - [EmploymentContract] - Employment Contract (HR)\r\n19 - [BillForWorkContract] - Bill for Work Contract\r\n20 - [BillForWorkOfMandate] - Bill for Work of Mandate\r\n21 - [SettlementAdvancePayment] - Advance Settlement\r\n22 - [AcceptanceReport] - Acceptance Report / Protocol\r\n23 - [HolidayRequest] - Holiday Request (HR)\r\n24 - [SickLeave] - Sick Leave (HR)\r\n25 - [PurchaseInvoiceResale] - Purchase Invoice - for resale / inventory\r\n26 - [ProformaPurchaseInvoice] - Purchase Invoice - Proforma / Announcement\r\n27 - [DeliveryDocument] - Proof of delivery\r\n28 - [ProformaSalesInvoice] - Sales Invoice - Proforma / Announcement\r\n29 - [Agreement] - Agreement (any)\r\n30 - [Policy] - Insurance policy\r\n31 - [AccountingNote] - Accounting note (special accounting document)\r\n32 - [Payment] - Payment\r\n33 - [DemandOfPayment] - Demand of payment\r\n34 - [TransferOrder] - Transfer order\r\n35 - [AccountingNoteDiscretionary] - Accounting note discretionary (special accounting document)\r\n36 - [Contract] - Contract\r\n37 - [FiscalReport] - Fiscal report\r\n38 - [SalesAdvance] - Sales advance\r\n39 - [SalesAdvanceCorrection] - Sales advance correction\r\n40 - [PurchaseAdvance] - Purchase advance\r\n41 - [PurchaseAdvanceCorrection] - Purchase advance correction\r\n-500 - [VirtualNoPermission] - Virutal record - no permission to all documents for reimbursement (read-only)\n\n1 = SalesInvoice\n\n2 = PurchaseInvoice\n\n3 = SalesReceipt\n\n4 = PurchaseReceipt\n\n5 = BankStatement\n\n6 = Declaration\n\n7 = CashDocument\n\n8 = CivilContract\n\n9 = Payroll\n\n10 = OtherDocument\n\n11 = PurchaseInvoiceCorrection\n\n12 = InterestNote\n\n13 = Delegation\n\n14 = SalesInvoiceCorrection\n\n15 = PersonnelDocument\n\n16 = WorkContract\n\n17 = WorkOfMandate\n\n18 = EmploymentContract\n\n19 = BillForWorkContract\n\n20 = BillForWorkOfMandate\n\n21 = SettlementAdvancePayment\n\n22 = AcceptanceReport\n\n23 = HolidayRequest\n\n24 = SickLeave\n\n25 = PurchaseInvoiceResale\n\n26 = ProformaPurchaseInvoice\n\n27 = DeliveryDocument\n\n28 = ProformaSalesInvoice\n\n29 = Agreement\n\n30 = Policy\n\n31 = AccountingNote\n\n32 = Payment\n\n33 = DemandOfPayment\n\n34 = TransferOrder\n\n35 = AccountingNoteDiscretionary\n\n36 = Contract\n\n37 = FiscalReport\n\n-500 = VirtualNoPermission",
"format": "int32",
"x-enumNames": [
"SalesInvoice",
"PurchaseInvoice",
"SalesReceipt",
"PurchaseReceipt",
"BankStatement",
"Declaration",
"CashDocument",
"CivilContract",
"Payroll",
"OtherDocument",
"PurchaseInvoiceCorrection",
"InterestNote",
"Delegation",
"SalesInvoiceCorrection",
"PersonnelDocument",
"WorkContract",
"WorkOfMandate",
"EmploymentContract",
"BillForWorkContract",
"BillForWorkOfMandate",
"SettlementAdvancePayment",
"AcceptanceReport",
"HolidayRequest",
"SickLeave",
"PurchaseInvoiceResale",
"ProformaPurchaseInvoice",
"DeliveryDocument",
"ProformaSalesInvoice",
"Agreement",
"Policy",
"AccountingNote",
"Payment",
"DemandOfPayment",
"TransferOrder",
"AccountingNoteDiscretionary",
"Contract",
"FiscalReport",
"VirtualNoPermission"
]
},
"APIDocumentTypeDef": {
"type": "object",
"properties": {
"DocumentTypeId": {
"type": "integer",
"description": "Document type ID",
"format": "int32"
},
"DocumentTypeName": {
"maxLength": 200,
"type": "string",
"description": "Name",
"nullable": true
},
"Direction": {
"type": "integer",
"description": "Direction: -1 costs, 1-revenues, 0-unknown",
"format": "int32"
},
"CanBeDigitized": {
"type": "boolean",
"description": "Can this type of document can be digitalized"
},
"IDAssignmentMethodGroup": {
"type": "integer",
"description": "INTERNAL USE ONLY",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Document type"
},
"APIDocumentTypeDefIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTypeDef"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentWithAIAndDimensionsResult": {
"type": "object",
"properties": {
"DocumentId": {
"type": "integer",
"description": "Document ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"StatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusDetails"
}
],
"description": "Document statuses details",
"nullable": true
},
"ContractorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentContractorDetails"
}
],
"description": "Contractor details (i.e. name, taxID, adress)",
"nullable": true
},
"TaxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTaxLine"
},
"description": "Summary of document's VAT calculations (in every VAT rate)",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentCurrencyDetails"
}
],
"description": "Document currency, rates, etc.",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPaymentDetails"
}
],
"description": "Payment details",
"nullable": true
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"DigitalizationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDigitalizationDetails"
}
],
"description": "Document digitalization details",
"nullable": true
},
"ReimbursementDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentReimbursementDetails"
}
],
"description": "Reimbursement details.\r\n\r\nOnly for POWER and above service level.",
"nullable": true
},
"OwnedByDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentOwnedByDetails"
}
],
"description": "Owned by details.\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
},
"VATStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentVATStatusDetails"
}
],
"description": "Details of contractor VAT Status (if checked)",
"nullable": true
},
"BankAccountStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentBankAccountStatusDetails"
}
],
"description": "Details of Bank Account status (if checked on whitelist)",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"DimensionsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DimensionsDetails"
}
],
"description": "Dimension details section",
"nullable": true
},
"AIDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AIDetails"
}
],
"description": "AI details section",
"nullable": true
},
"KsefDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentKsefDetails"
}
],
"description": "Details of KSeF",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document with AI details"
},
"APIDocumentWithAIAndDimensionsResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentWithAIAndDimensionsResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentWithDimensionsResult": {
"type": "object",
"properties": {
"DocumentId": {
"type": "integer",
"description": "Document ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"StatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatusDetails"
}
],
"description": "Document statuses details",
"nullable": true
},
"ContractorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentContractorDetails"
}
],
"description": "Contractor details (i.e. name, taxID, adress)",
"nullable": true
},
"TaxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentTaxLine"
},
"description": "Summary of document's VAT calculations (in every VAT rate)",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentCurrencyDetails"
}
],
"description": "Document currency, rates, etc.",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPaymentDetails"
}
],
"description": "Payment details",
"nullable": true
},
"AccountingDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentAccountingDetails"
}
],
"description": "Accounting specific detalis",
"nullable": true
},
"DigitalizationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDigitalizationDetails"
}
],
"description": "Document digitalization details",
"nullable": true
},
"ReimbursementDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentReimbursementDetails"
}
],
"description": "Reimbursement details.\r\n\r\nOnly for POWER and above service level.",
"nullable": true
},
"OwnedByDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentOwnedByDetails"
}
],
"description": "Owned by details.\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
},
"VATStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentVATStatusDetails"
}
],
"description": "Details of contractor VAT Status (if checked)",
"nullable": true
},
"BankAccountStatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentBankAccountStatusDetails"
}
],
"description": "Details of Bank Account status (if checked on whitelist)",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"DimensionsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DimensionsDetails"
}
],
"description": "Dimension details section",
"nullable": true
},
"KsefDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentKsefDetails"
}
],
"description": "Details of KSeF",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document with dimensions"
},
"APIDocumentWithDimensionsResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentWithDimensionsResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIDocumentWithDimensionsResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIDocumentWithDimensionsResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIExcelReportTemplate": {
"type": "object",
"properties": {
"StaticFileId": {
"type": "integer",
"description": "Static file Id",
"format": "int32"
},
"FileUserFriendlyName": {
"type": "string",
"description": "File name - user friendly",
"nullable": true
},
"FileName": {
"type": "string",
"description": "File name",
"nullable": true
},
"FileDescription": {
"type": "string",
"description": "File description",
"nullable": true
}
},
"additionalProperties": false,
"description": "Excel report template object"
},
"APIExcelReportTemplateIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIExcelReportTemplate"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIExternalAttachment": {
"type": "object",
"properties": {
"FileName": {
"type": "string",
"description": "Original file name",
"nullable": true
},
"ContentType": {
"type": "string",
"description": "Content type",
"nullable": true
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": "External attachment file"
},
"APIExternalAttachmentResult": {
"type": "object",
"properties": {
"ExternalAttachmentId": {
"type": "integer",
"description": "External attachment ID",
"format": "int32"
},
"FileName": {
"type": "string",
"description": "Original file name",
"nullable": true
},
"ContentType": {
"type": "string",
"description": "Content type",
"nullable": true
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": "External attachment object [result]"
},
"APIExternalAttachmentResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIExternalAttachmentResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIFactor": {
"required": [
"BankAccountNumber",
"Name"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Name"
},
"IdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Identifier type \r\n\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n10 - [NoIdentificationMethod] - no identifier specified \r\n\r\nDefault: TaxID\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Factor Identifier\r\nType based on IdentifierType",
"nullable": true
},
"FriendlyName": {
"maxLength": 200,
"type": "string",
"description": "Factor name visible only in Taxxo",
"nullable": true
},
"IsActive": {
"type": "boolean",
"description": "True - A factor will be active\r\nDefault: true",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Internal notes (not displayed on the invoice)",
"nullable": true
},
"AdditionalInvoiceInfo": {
"type": "string",
"description": "Additional information to be included in the invoice footer\r\n(if left empty, no information will be included).",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City",
"nullable": true
},
"AddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"CountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"BankAccountNumber": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Bank account number"
},
"BankAccountSWIFT": {
"maxLength": 50,
"type": "string",
"description": "Bank account SWIFT",
"nullable": true
},
"VATBankAccountNumber": {
"maxLength": 50,
"type": "string",
"description": "Bank account number for VAT payment in base currency",
"nullable": true
},
"VATBankAccountSWIFT": {
"maxLength": 50,
"type": "string",
"description": "Bank account SWIFT for VAT payment in base currency",
"nullable": true
}
},
"additionalProperties": false,
"description": "Factor object"
},
"APIFactorResult": {
"required": [
"BankAccountNumber",
"Name"
],
"type": "object",
"properties": {
"FactorId": {
"type": "integer",
"description": "Factor ID",
"format": "int32"
},
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Name"
},
"IdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Identifier type \r\n\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n10 - [NoIdentificationMethod] - no identifier specified \r\n\r\nDefault: TaxID\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Factor Identifier\r\nType based on IdentifierType",
"nullable": true
},
"FriendlyName": {
"maxLength": 200,
"type": "string",
"description": "Factor name visible only in Taxxo",
"nullable": true
},
"IsActive": {
"type": "boolean",
"description": "True - A factor will be active\r\nDefault: true",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Internal notes (not displayed on the invoice)",
"nullable": true
},
"AdditionalInvoiceInfo": {
"type": "string",
"description": "Additional information to be included in the invoice footer\r\n(if left empty, no information will be included).",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City",
"nullable": true
},
"AddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"CountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"BankAccountNumber": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Bank account number"
},
"BankAccountSWIFT": {
"maxLength": 50,
"type": "string",
"description": "Bank account SWIFT",
"nullable": true
},
"VATBankAccountNumber": {
"maxLength": 50,
"type": "string",
"description": "Bank account number for VAT payment in base currency",
"nullable": true
},
"VATBankAccountSWIFT": {
"maxLength": 50,
"type": "string",
"description": "Bank account SWIFT for VAT payment in base currency",
"nullable": true
}
},
"additionalProperties": false,
"description": "Factor object"
},
"APIFactorResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIFactorResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIFactorResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIFactorResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIIndividualReport": {
"type": "object",
"properties": {
"FileDetails": {
"allOf": [
{
"$ref": "#/components/schemas/IndividualReportFileDetails"
}
],
"description": "Individual report file section",
"nullable": true
},
"Name": {
"type": "string",
"description": "Individual report name",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Notes",
"nullable": true
}
},
"additionalProperties": false,
"description": "Individual report object"
},
"APIIndividualReportResult": {
"type": "object",
"properties": {
"IndividualReportId": {
"type": "integer",
"description": "Individual report Id",
"format": "int32"
},
"Name": {
"type": "string",
"description": "Individual report name",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Notes",
"nullable": true
},
"ModifiedByUserLogin": {
"type": "string",
"description": "ostatnio modyfikowal/a raport",
"nullable": true
},
"ModificationDate": {
"type": "string",
"description": "Modification date",
"format": "date-time"
},
"FileName": {
"type": "string",
"description": "File name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Individual report object"
},
"APIIndividualReportResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIIndividualReportResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIIndividualReportResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIndividualReportResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIIntegrationParameter": {
"type": "object",
"properties": {
"LastDocumentDate": {
"type": "string",
"description": "Last document date",
"format": "date-time",
"nullable": true
},
"LastIntegrationDate": {
"type": "string",
"description": "Last successful integration date",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Parameter object"
},
"APIIntegrationParameterAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIIntegrationParameter"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInterestNote": {
"required": [
"BuyerDetails",
"RelatedDocumentIds"
],
"type": "object",
"properties": {
"RelatedDocumentIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Interest Note related documents Ids"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteGeneral"
}
],
"description": "General section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteBuyerDetails"
}
],
"description": "Buyer"
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteCurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNotePaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteAppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteInternalDetails"
}
],
"description": "Internal section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Interest Note object"
},
"APIInterestNoteItemResult": {
"type": "object",
"properties": {
"ItemId": {
"type": "integer",
"description": "Item ID",
"format": "int32"
},
"DocumentId": {
"type": "integer",
"description": "Id of source document",
"format": "int32",
"nullable": true
},
"DocumentNumber": {
"maxLength": 250,
"type": "string",
"description": "Number of source document - (e.g., invoice number)",
"nullable": true
},
"MadeOutDate": {
"type": "string",
"description": "Date the document was issued",
"format": "date-time",
"nullable": true
},
"PaymentDeadline": {
"type": "string",
"description": "Document payment deadline",
"format": "date-time",
"nullable": true
},
"LastSettlementDate": {
"type": "string",
"description": "Date of the last document settlement",
"format": "date-time",
"nullable": true
},
"TotalGross": {
"type": "number",
"description": "Total gross amount of the document in the document's currency",
"format": "double",
"nullable": true
},
"InterestAmount": {
"type": "number",
"description": "Total interest value for this document",
"format": "double",
"nullable": true
},
"SubItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInterestNoteSubItemResult"
},
"description": "Sub items of interest note",
"nullable": true
}
},
"additionalProperties": false,
"description": "Interest Note item object [result]"
},
"APIInterestNotePaymentStatus": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "Interest note payment status:\r\n\r\n0 - [Unpaid] - Unpaid\r\n1 - [Paid] - Paid\r\n2 - [Canceled] - Canceled\n\n0 = Unpaid\n\n1 = Paid\n\n2 = Canceled",
"format": "int32",
"x-enumNames": [
"Unpaid",
"Paid",
"Canceled"
]
},
"APIInterestNoteResult": {
"required": [
"BuyerDetails"
],
"type": "object",
"properties": {
"IDInterestNote": {
"type": "integer",
"description": "Interest Note ID",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteGeneral"
}
],
"description": "General section",
"nullable": true
},
"Summary": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteSummary"
}
],
"description": "Summary section (total values)",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteBuyerDetails"
}
],
"description": "Buyer"
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteCurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNotePaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteAppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteInternalDetails"
}
],
"description": "Internal section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Interest Note object [result]"
},
"APIInterestNoteResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInterestNoteResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInterestNoteResultOne": {
"required": [
"BuyerDetails"
],
"type": "object",
"properties": {
"IDInterestNote": {
"type": "integer",
"description": "Interest Note ID",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteGeneral"
}
],
"description": "General section",
"nullable": true
},
"Summary": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteSummary"
}
],
"description": "Summary section (total values)",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteBuyerDetails"
}
],
"description": "Buyer"
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteCurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNotePaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteAppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InterestNoteInternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInterestNoteItemResult"
},
"description": "Interest Note items",
"nullable": true
}
},
"additionalProperties": false,
"description": "Interest Note object [result] return by a method that returns a single object"
},
"APIInterestNoteResultOneAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIInterestNoteResultOne"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInterestNoteSubItemResult": {
"type": "object",
"properties": {
"InterestRatePercent": {
"type": "number",
"description": "Interest rate as a percentage.",
"format": "double",
"nullable": true,
"readOnly": true
},
"AmountOverdue": {
"type": "number",
"description": "Overdue amount within a given time period",
"format": "double",
"nullable": true
},
"DateFrom": {
"type": "string",
"description": "Time period for which interest is calculated - start date",
"format": "date-time",
"nullable": true
},
"DateTo": {
"type": "string",
"description": "Time period for which interest is calculated - end date",
"format": "date-time",
"nullable": true
},
"NumberOfDays": {
"type": "integer",
"description": "Time period for which interest is calculated - number of days",
"format": "int32",
"nullable": true
},
"InterestRate": {
"type": "number",
"description": "Interest rate percentage",
"format": "double",
"nullable": true
},
"InterestAmount": {
"type": "number",
"description": "Interest amount",
"format": "double",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Note",
"nullable": true
}
},
"additionalProperties": false,
"description": "InterestNote SubItem object [result]"
},
"APIInterestType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Interest type:\r\n\r\n0 - [GovermentOverdue] - Government interest for overdue payments\r\n1 - [Custom] - Custom or contractual interest\r\n2 - [Business] - Statutory interest for commercial transactions\r\n3 - [BusinessMedical] - Statutory interest for commercial transactions (medical public entity)\n\n0 = GovermentOverdue\n\n1 = Custom\n\n2 = Business\n\n3 = BusinessMedical",
"format": "int32",
"x-enumNames": [
"GovermentOverdue",
"Custom",
"Business",
"BusinessMedical"
]
},
"APIInternalAttachment": {
"type": "object",
"properties": {
"FileName": {
"type": "string",
"description": "Original file name",
"nullable": true
},
"ContentType": {
"type": "string",
"description": "Content type",
"nullable": true
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": "Internal attachment file"
},
"APIInternalAttachmentCountResult": {
"type": "object",
"properties": {
"InternalAttachmentFileCount": {
"type": "integer",
"description": "Number of file attachments.",
"format": "int32"
},
"InternalUrlAttachmentCount": {
"type": "integer",
"description": "Number of URL attachments.",
"format": "int32"
},
"InternalRelatedAttachmentCount": {
"type": "integer",
"description": "Number of related-object attachments.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Internal attachment counters grouped by type."
},
"APIInternalAttachmentCountResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIInternalAttachmentCountResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInternalAttachmentResult": {
"type": "object",
"properties": {
"InternalAttachmentId": {
"type": "integer",
"description": "Internal attachment ID",
"format": "int32"
},
"InternalAttachmentFile": {
"allOf": [
{
"$ref": "#/components/schemas/APIInternalAttachment"
}
],
"description": "Internal attachment",
"nullable": true
},
"InternalUrlAttachment": {
"allOf": [
{
"$ref": "#/components/schemas/APIInternalUrlAttachment"
}
],
"description": "Internal URL attachment",
"nullable": true
},
"InternalRelatedAttachment": {
"allOf": [
{
"$ref": "#/components/schemas/APIInternalRelatedAttachment"
}
],
"description": "Internal related attachment",
"nullable": true
}
},
"additionalProperties": false,
"description": "Internal attachment object [result]"
},
"APIInternalAttachmentResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInternalAttachmentResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInternalRelatedAttachment": {
"type": "object",
"properties": {
"ObjectType": {
"allOf": [
{
"$ref": "#/components/schemas/APIInternalRelatedAttachmentType"
}
],
"description": "Related object attachment type:\r\n\r\n1 - [Document] - Document\r\n2 - [Invoice] - Invoice\r\n3 - [Cash document] - Cash document\n\n1 = Document\n\n2 = Invoice\n\n3 = CashDocument",
"x-enumNames": [
"Document",
"Invoice",
"CashDocument"
]
},
"RelatedObjectId": {
"type": "integer",
"description": "Related object attachement ID (internal)",
"format": "int32"
},
"Note": {
"type": "string",
"description": "Note",
"nullable": true
}
},
"additionalProperties": false,
"description": "Internal related attachment"
},
"APIInternalRelatedAttachmentType": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Related attachment type:\r\n\r\n1 - [Document] - Document\r\n2 - [Invoice] - Invoice\r\n3 - [Cash document] - Cash document\n\n1 = Document\n\n2 = Invoice\n\n3 = CashDocument",
"format": "int32",
"x-enumNames": [
"Document",
"Invoice",
"CashDocument"
]
},
"APIInternalUrlAttachment": {
"type": "object",
"properties": {
"URL": {
"type": "string",
"description": "URL",
"nullable": true
},
"Note": {
"type": "string",
"description": "Note to URL",
"nullable": true
}
},
"additionalProperties": false,
"description": "URL as an internal attachment"
},
"APIInvoice": {
"required": [
"BuyerDetails",
"Items"
],
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"KSeFDetails": {
"allOf": [
{
"$ref": "#/components/schemas/KSeFDetailsBase"
}
],
"description": "KSeF details",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItem"
},
"description": "Invoice items"
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetailsBase"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"PrintSettings": {
"allOf": [
{
"$ref": "#/components/schemas/PrintSettings"
}
],
"description": "Optional print settings (how invoice would render into PDF)",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice object"
},
"APIInvoiceAdvance": {
"required": [
"BuyerDetails",
"Items"
],
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"KSeFDetails": {
"allOf": [
{
"$ref": "#/components/schemas/KSeFDetailsBase"
}
],
"description": "KSeF details",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItem"
},
"description": "Invoice items"
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetailsBase"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"PrintSettings": {
"allOf": [
{
"$ref": "#/components/schemas/PrintSettings"
}
],
"description": "Optional print settings (how invoice would render into PDF)",
"nullable": true
},
"AdvanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AdvanceDetails"
}
],
"description": "Advance details",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice advance object"
},
"APIInvoiceAnalysisByTagGroupResult": {
"required": [
"BuyerDetails"
],
"type": "object",
"properties": {
"InvoiceId": {
"type": "integer",
"description": "Invoice ID",
"format": "int32"
},
"Additional": {
"allOf": [
{
"$ref": "#/components/schemas/Additional"
}
],
"description": "Addtional section (read-only)",
"nullable": true
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"KSeFDetails": {
"allOf": [
{
"$ref": "#/components/schemas/KSeFDetails"
}
],
"description": "KSeF details",
"nullable": true
},
"Summary": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceSummary"
}
],
"description": "Summary section (total values)",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItemResult"
},
"description": "Invoice items",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetails"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"AllocationByTag": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationByTag"
}
],
"description": "Allocation by tag section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice analysis by tag group (result operation)"
},
"APIInvoiceAnalysisByTagGroupResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceAnalysisByTagGroupResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceAnalysisResult": {
"required": [
"BuyerDetails"
],
"type": "object",
"properties": {
"InvoiceId": {
"type": "integer",
"description": "Invoice ID",
"format": "int32"
},
"Additional": {
"allOf": [
{
"$ref": "#/components/schemas/Additional"
}
],
"description": "Addtional section (read-only)",
"nullable": true
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"KSeFDetails": {
"allOf": [
{
"$ref": "#/components/schemas/KSeFDetails"
}
],
"description": "KSeF details",
"nullable": true
},
"Summary": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceSummary"
}
],
"description": "Summary section (total values)",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItemResult"
},
"description": "Invoice items",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetails"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice analysis (result operation)"
},
"APIInvoiceAnalysisResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceAnalysisResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceChange": {
"required": [
"BuyerDetails",
"Items"
],
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItem"
},
"description": "Invoice items"
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetailsBase"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"PrintSettings": {
"allOf": [
{
"$ref": "#/components/schemas/PrintSettings"
}
],
"description": "Optional print settings (how invoice would render into PDF)",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice object"
},
"APIInvoiceCorrection": {
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralCorrection"
}
],
"description": "General section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"PrintSettings": {
"allOf": [
{
"$ref": "#/components/schemas/PrintSettings"
}
],
"description": "Optional print settings (how invoice would render into PDF)",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"ChangedItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItemCorrection"
},
"description": "Changed items",
"nullable": true
},
"NewItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItem"
},
"description": "Changed items",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice correction object"
},
"APIInvoiceCorrectionToZero": {
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralCorrection"
}
],
"description": "General section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"PrintSettings": {
"allOf": [
{
"$ref": "#/components/schemas/PrintSettings"
}
],
"description": "Optional print settings (how invoice would render into PDF)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice correction to zero object"
},
"APIInvoiceCycle": {
"required": [
"CycleGeneral",
"InvoiceDetails"
],
"type": "object",
"properties": {
"CycleGeneral": {
"allOf": [
{
"$ref": "#/components/schemas/CycleGeneral"
}
],
"description": "General information about invoice cycle"
},
"InvoiceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceDetails"
}
],
"description": "Invoice details section"
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice cycle object"
},
"APIInvoiceCycleGenerationDays": {
"enum": [
0,
1
],
"type": "integer",
"description": "Exclude working days whene generating invoices from cycles:\r\n\r\n0 - [OnlyWorking] - Generate invoices only on working days\r\n1 - [WorkingAndHolydays] - Generate invoices in all days\n\n0 = OnlyWorking\n\n1 = WorkingAndHolydays",
"format": "int32",
"x-enumNames": [
"OnlyWorking",
"WorkingAndHolydays"
]
},
"APIInvoiceCycleGenerationMethod": {
"enum": [
0,
1
],
"type": "integer",
"description": "What to do after generating invoice:\r\n\r\n0 - [Print] - Do nothing - i will print or send this email\r\n1 - [Email] - Send invoice via email\n\n0 = Print\n\n1 = Email",
"format": "int32",
"x-enumNames": [
"Print",
"Email"
]
},
"APIInvoiceCycleInvoiceType": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "Invoice type:\r\n\r\n0 - [Invoice] - Invoice with VAT\r\n1 - [InvoiceEU] - EU Invoice with VAT\r\n2 - [Margin] - Margin Invoice\r\n3 - [Bill] - Bill (no VAT)\r\n4 - [ReverseCharge] - Reverse Charge\r\n5 - [Proform] - Proform Invoice\r\n6 - [ProformEU] - EU Proform Invoice\n\n0 = Invoice\n\n1 = InvoiceEU\n\n2 = Margin\n\n3 = Bill\n\n4 = ReverseCharge\n\n5 = Proform\n\n6 = ProformEU",
"format": "int32",
"x-enumNames": [
"Invoice",
"InvoiceEU",
"Margin",
"Bill",
"ReverseCharge",
"Proform",
"ProformEU"
]
},
"APIInvoiceCyclePeriodType": {
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "Invoice cycle period type:\r\n\r\n1 - [Monthly] - Every month\r\n2 - [BiMonthly] - Every two months\r\n3 - [Quarterly] - Every 3 months\r\n4 - [HalfYear] - Every 6 months\r\n5 - [Yearly] - Every 12 months\r\n6 - [Weekly] - Every week\n\n1 = Monthly\n\n2 = BiMonthly\n\n3 = Quarterly\n\n4 = HalfYear\n\n5 = Yearly\n\n6 = Weekly",
"format": "int32",
"x-enumNames": [
"Monthly",
"BiMonthly",
"Quarterly",
"HalfYear",
"Yearly",
"Weekly"
]
},
"APIInvoiceCycleResult": {
"required": [
"CycleGeneral",
"InvoiceDetails"
],
"type": "object",
"properties": {
"InvoiceCycleId": {
"type": "integer",
"description": "Invoice cycle ID",
"format": "int32"
},
"StateInfo": {
"allOf": [
{
"$ref": "#/components/schemas/StateInfo"
}
],
"description": "invoice state (active, suspended, terminated)",
"nullable": true
},
"CycleGeneral": {
"allOf": [
{
"$ref": "#/components/schemas/CycleGeneral"
}
],
"description": "General information about invoice cycle"
},
"GeneratedInvoicesInfo": {
"allOf": [
{
"$ref": "#/components/schemas/GeneratedInvoicesInfo"
}
],
"description": "extra info about generated invoices",
"nullable": true
},
"InvoiceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceDetails"
}
],
"description": "Invoice details section"
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice cycle object [result]"
},
"APIInvoiceCycleResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycleResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceCycleResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceCycleResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceCycleSellingDateType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "How selling date would be generated in new invoice:\r\n\r\n0 - [InvoiceMadeOutDate] - Same as made-out date\r\n1 - [FirstDayOfMonth] - First day of current month\r\n2 - [LastDayOfMonth] - Last day of previous month\n\n0 = InvoiceMadeOutDate\n\n1 = FirstDayOfMonth\n\n2 = LastDayOfMonth",
"format": "int32",
"x-enumNames": [
"InvoiceMadeOutDate",
"FirstDayOfMonth",
"LastDayOfMonth"
]
},
"APIInvoiceCycleState": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Invoice cycle state:\r\n\r\n1 - [Active] - Cycle is active - invoice would be generated\r\n2 - [Suspended] - Cycle is temporarily suspended - invoice would NOT be generated\r\n3 - [Terminated] - Cycle is terminated (by user or expired by endDate param) - invoice would NOT be generated\n\n1 = Active\n\n2 = Suspended\n\n3 = Terminated",
"format": "int32",
"x-enumNames": [
"Active",
"Suspended",
"Terminated"
]
},
"APIInvoiceFinalizedChange": {
"type": "object",
"properties": {
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Object represents the payload for changes to elements on finalized KSeF invoices"
},
"APIInvoiceFlagColor": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"description": "Flag color:\r\n\r\n0 - [NoFlag] - no flag\r\n1 - [Red] - red color\r\n2 - [Orange] - orange color\r\n3 - [Yellow] - yellow color\r\n4 - [Green] - green color\r\n5 - [Violet] - violet color\r\n6 - [Blue] - blue color\r\n7 - [Pink] - pink color\n\n0 = NoFlag\n\n1 = Red\n\n2 = Orange\n\n3 = Yellow\n\n4 = Green\n\n5 = Violet\n\n6 = Blue\n\n7 = Pink",
"format": "int32",
"x-enumNames": [
"NoFlag",
"Red",
"Orange",
"Yellow",
"Green",
"Violet",
"Blue",
"Pink"
]
},
"APIInvoiceItem": {
"type": "object",
"properties": {
"ProductName": {
"maxLength": 300,
"type": "string",
"description": "Product name",
"nullable": true
},
"ProductId": {
"type": "integer",
"description": "Product ID (optional)",
"format": "int32",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"Unit": {
"maxLength": 20,
"type": "string",
"description": "Unit",
"nullable": true
},
"NetPrice": {
"type": "number",
"description": "Net price\r\n\r\nCheck APIItemsAmountCalculateType",
"format": "double",
"nullable": true
},
"GrossPrice": {
"type": "number",
"description": "Gross price \r\n\r\nCheck APIItemsAmountCalculateType",
"format": "double",
"nullable": true
},
"TaxRate": {
"maxLength": 50,
"type": "string",
"description": "Tax rate - percent or text label (like RC)",
"nullable": true
},
"Discount": {
"type": "number",
"description": "Percentage discount - applicable when DiscountType is null or set to Percent",
"format": "double"
},
"DiscountAmount": {
"type": "number",
"description": "Amount discount - applicable when DiscountType is set to Amount",
"format": "double",
"nullable": true
},
"ProductVATCode": {
"type": "string",
"description": "Optional - goverment VAT Code assigned to this product type",
"nullable": true
},
"LineDescription": {
"type": "string",
"description": "Optional - Line description of item",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"UpdateProductData": {
"type": "boolean",
"description": "Whether to modify a defined product data\r\nOptional - default true \r\nOn the platform, it is possible to block changes regardless of the parameter UpdateProductData\r\nOnly used when adding and changing invoices",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section for invoice item",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice item"
},
"APIInvoiceItemCorrection": {
"type": "object",
"properties": {
"ParentItemId": {
"type": "integer",
"description": "Parent item ID",
"format": "int32"
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"Unit": {
"maxLength": 20,
"type": "string",
"description": "Unit",
"nullable": true
},
"NetPrice": {
"type": "number",
"description": "Net price \r\n\r\nCheck APIItemsAmountCalculateType",
"format": "double",
"nullable": true
},
"GrossPrice": {
"type": "number",
"description": "Gross price \r\n\r\nCheck APIItemsAmountCalculateType",
"format": "double",
"nullable": true
},
"TaxRate": {
"maxLength": 50,
"type": "string",
"description": "Tax rate - percent or text label (like RC)",
"nullable": true
},
"Discount": {
"type": "number",
"description": "Percentage discount",
"format": "double",
"nullable": true
},
"ProductVATCode": {
"type": "string",
"description": "Optional - goverment VAT Code assigned to this product type",
"nullable": true
},
"LineDescription": {
"type": "string",
"description": "Optional - Line description of item",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Optional - custom fields assigned to this item",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice correction item object"
},
"APIInvoiceItemCorrectionChange": {
"type": "object",
"properties": {
"TotalNet": {
"type": "number",
"description": "Total net for corrections calculated as delta (current invoice minus parent invoice)",
"format": "double",
"nullable": true
},
"TotalGross": {
"type": "number",
"description": "Total gross for corrections calculated as delta (current invoice minus parent invoice)",
"format": "double",
"nullable": true
},
"TotalTax": {
"type": "number",
"description": "Total tax for corrections calculated as delta (current invoice minus parent invoice)",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Change of value for an invoice item object - applies only to correction invoices"
},
"APIInvoiceItemResult": {
"type": "object",
"properties": {
"ItemId": {
"type": "integer",
"description": "Item ID",
"format": "int32"
},
"ProductName": {
"maxLength": 300,
"type": "string",
"description": "Product name",
"nullable": true
},
"ProductId": {
"type": "integer",
"description": "Product ID (optional)",
"format": "int32",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"Unit": {
"maxLength": 20,
"type": "string",
"description": "Unit",
"nullable": true
},
"NetPrice": {
"type": "number",
"description": "Net price\r\n\r\nCheck APIItemsAmountCalculateType",
"format": "double",
"nullable": true
},
"GrossPrice": {
"type": "number",
"description": "Gross price \r\n\r\nCheck APIItemsAmountCalculateType",
"format": "double",
"nullable": true
},
"TaxRate": {
"maxLength": 50,
"type": "string",
"description": "Tax rate - percent or text label (like RC)",
"nullable": true
},
"Discount": {
"type": "number",
"description": "Percentage discount - applicable when DiscountType is null or set to Percent",
"format": "double"
},
"DiscountAmount": {
"type": "number",
"description": "Amount discount - applicable when DiscountType is set to Amount",
"format": "double",
"nullable": true
},
"ProductVATCode": {
"type": "string",
"description": "Optional - goverment VAT Code assigned to this product type",
"nullable": true
},
"LineDescription": {
"type": "string",
"description": "Optional - Line description of item",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"UpdateProductData": {
"type": "boolean",
"description": "Whether to modify a defined product data\r\nOptional - default true \r\nOn the platform, it is possible to block changes regardless of the parameter UpdateProductData\r\nOnly used when adding and changing invoices",
"nullable": true
},
"CorrectionChange": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceItemCorrectionChange"
}
],
"description": "Change of value for an invoice item - applies only to correction invoices",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section for invoice item",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice item object [result]"
},
"APIInvoiceMadeOutDateMode": {
"enum": [
0,
1
],
"type": "integer",
"description": "Invoice made out date mode - KSeF related\r\n\r\n0 - [Default] - The invoice made out date is set when the invoice is sent to KSeF.\r\n1 - [LastDayOfPreviousMonthOnNextBusinessDay] - Sets the invoice made out date to the last day of the previous month if the invoice is sent to KSeF on the next business day.\n\n0 = Default\n\n1 = LastDayOfPreviousMonthOnNextBusinessDay",
"format": "int32",
"x-enumNames": [
"Default",
"LastDayOfPreviousMonthOnNextBusinessDay"
]
},
"APIInvoiceResult": {
"required": [
"BuyerDetails"
],
"type": "object",
"properties": {
"InvoiceId": {
"type": "integer",
"description": "Invoice ID",
"format": "int32"
},
"Additional": {
"allOf": [
{
"$ref": "#/components/schemas/Additional"
}
],
"description": "Addtional section (read-only)",
"nullable": true
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"KSeFDetails": {
"allOf": [
{
"$ref": "#/components/schemas/KSeFDetails"
}
],
"description": "KSeF details",
"nullable": true
},
"Summary": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceSummary"
}
],
"description": "Summary section (total values)",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItemResult"
},
"description": "Invoice items",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetails"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice object [result]"
},
"APIInvoiceResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceResultOne": {
"required": [
"BuyerDetails"
],
"type": "object",
"properties": {
"InvoiceId": {
"type": "integer",
"description": "Invoice ID",
"format": "int32"
},
"Additional": {
"allOf": [
{
"$ref": "#/components/schemas/Additional"
}
],
"description": "Addtional section (read-only)",
"nullable": true
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"KSeFDetails": {
"allOf": [
{
"$ref": "#/components/schemas/KSeFDetails"
}
],
"description": "KSeF details",
"nullable": true
},
"Summary": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceSummary"
}
],
"description": "Summary section (total values)",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItemResult"
},
"description": "Invoice items",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetails"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice object [result] return by a method that returns a single object"
},
"APIInvoiceResultOneAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceResultOne"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceSeries": {
"type": "object",
"properties": {
"GeneralSeries": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralSeries"
}
],
"description": "General series section",
"nullable": true
},
"DocumentTypeDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentTypeDetails"
}
],
"description": "Document type section",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetailsSeries"
}
],
"description": "Payment section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice series"
},
"APIInvoiceSeriesAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceSeries"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceSeriesIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceSeries"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIInvoiceSourceType": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Type of invoice source \r\n\r\n1 - [ContractorInvoice] - Contractor invoice\r\n2 - [OtherInvoice] - Other invoice\r\n3 - [ProductList] - Product list\n\n1 = ContractorInvoice\n\n2 = OtherInvoice\n\n3 = ProductList",
"format": "int32",
"x-enumNames": [
"ContractorInvoice",
"OtherInvoice",
"ProductList"
]
},
"APIInvoiceStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"type": "integer",
"description": "Invoice status\n\n0 = NotApplicable\n\n1 = Draft\n\n2 = ReadyToSend\n\n3 = AwaitingBackJob\n\n4 = IssuedOffline\n\n5 = IssuedOffline24\n\n6 = XmlImportedAwaitingExternalConfirmation\n\n7 = Sending\n\n8 = SentToKsef\n\n9 = KsefError\n\n10 = RejectedByKsef\n\n11 = KsefNumberAssigned\n\n12 = SourceDocumentsConfirmed\n\n13 = Interrupted\n\n14 = Canceled",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"Draft",
"ReadyToSend",
"AwaitingBackJob",
"IssuedOffline",
"IssuedOffline24",
"XmlImportedAwaitingExternalConfirmation",
"Sending",
"SentToKsef",
"KsefError",
"RejectedByKsef",
"KsefNumberAssigned",
"SourceDocumentsConfirmed",
"Interrupted",
"Canceled"
]
},
"APIInvoiceType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"type": "integer",
"description": "Invoice type:\r\n\r\n0 - [Invoice] - Invoice with VAT\r\n1 - [InvoiceEU] - EU Invoice with VAT\r\n2 - [Margin] - Margin Invoice\r\n3 - [Bill] - Bill (no VAT)\r\n4 - [ReverseCharge] - Reverse Charge\r\n5 - [Proform] - Proform Invoice\r\n6 - [ProformEU] - EU Proform Invoice\r\n7 - [Correction] - Correction Invoice (not to edit)\r\n8 - [CorrectionEU] - EU Correction Invoice (not to edit)\r\n9 - [Advance] - Advance Invoice (not to edit)\r\n10 - [ReverseChargeCorrection] - Reverse Charge Correction (not to edit)\r\n11 - [BillCorrection] - Bill Correction (not to edit)\r\n12 - [MarginInvoiceCorrection ] - Margin Invoice Correction (not to edit)\r\n13 - [AccountingNote] - Accounting Note (not to edit)\r\n14 - [MarginInvoiceProforma] - MarginInvoice Proforma (not to edit)\n\n0 = Invoice\n\n1 = InvoiceEU\n\n2 = Margin\n\n3 = Bill\n\n4 = ReverseCharge\n\n5 = Proform\n\n6 = ProformEU\n\n7 = Correction\n\n8 = CorrectionEU\n\n9 = Advance\n\n10 = ReverseChargeCorrection\n\n11 = BillCorrection\n\n12 = MarginInvoiceCorrection\n\n13 = AccountingNote\n\n14 = MarginInvoiceProforma",
"format": "int32",
"x-enumNames": [
"Invoice",
"InvoiceEU",
"Margin",
"Bill",
"ReverseCharge",
"Proform",
"ProformEU",
"Correction",
"CorrectionEU",
"Advance",
"ReverseChargeCorrection",
"BillCorrection",
"MarginInvoiceCorrection",
"AccountingNote",
"MarginInvoiceProforma"
]
},
"APIInvoiceWithDimensionsResult": {
"required": [
"BuyerDetails"
],
"type": "object",
"properties": {
"InvoiceId": {
"type": "integer",
"description": "Invoice ID",
"format": "int32"
},
"Additional": {
"allOf": [
{
"$ref": "#/components/schemas/Additional"
}
],
"description": "Addtional section (read-only)",
"nullable": true
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/General"
}
],
"description": "General section",
"nullable": true
},
"KSeFDetails": {
"allOf": [
{
"$ref": "#/components/schemas/KSeFDetails"
}
],
"description": "KSeF details",
"nullable": true
},
"Summary": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceSummary"
}
],
"description": "Summary section (total values)",
"nullable": true
},
"ParentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ParentDetails"
}
],
"description": "Parent section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItemResult"
},
"description": "Invoice items",
"nullable": true
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"RecieverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Reciever (optional if other then Buyer)",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetails"
}
],
"description": "Factor details",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section",
"nullable": true
},
"DimensionsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/DimensionsDetails"
}
],
"description": "Dimension details section",
"nullable": true
},
"AllocationDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AllocationDetails"
}
],
"description": "Allocation details section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice with dimensions details"
},
"APIInvoiceWithDimensionsResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceWithDimensionsResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIIssue": {
"type": "object",
"properties": {
"Subject": {
"maxLength": 300,
"type": "string",
"description": "Issue subject",
"nullable": true
},
"TargetPersonRole": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssuePersonRole"
}
],
"description": " Role of the user who is target of issue\r\n1 - [CompanyOwner] - Company owner\r\n2 - [CompanyManager] - Company manager\r\n3 - [CompanyEmployee] - Company employee\r\n4 - [ChiefAccountant] - Chief accountant\r\n5 - [Accountant] - Accountant\r\n6 - [HumanResources] - Human resources\r\n7 - [HeadAccountant] - Head accountant\n\n1 = CompanyOwner\n\n2 = CompanyManager\n\n3 = CompanyEmployee\n\n4 = ChiefAccountant\n\n5 = Accountant\n\n6 = HumanResources\n\n7 = HeadAccountant",
"x-enumNames": [
"CompanyOwner",
"CompanyManager",
"CompanyEmployee",
"ChiefAccountant",
"Accountant",
"HumanResources",
"HeadAccountant"
]
},
"Deadline": {
"type": "string",
"description": "Issue deadline",
"format": "date-time",
"nullable": true
},
"IsConfidential": {
"type": "boolean",
"description": "True - issue should be considered as confidential (special permission reguired) \r\nDefault: false"
},
"AccountingYear": {
"type": "string",
"description": "Accounting year to which issue is related",
"nullable": true
},
"Content": {
"type": "string",
"description": "Issue content",
"nullable": true
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueAttachment"
},
"description": "Issue attachments",
"nullable": true
},
"UserLogin": {
"type": "string",
"description": "Login of the user creating the issue. (Required when logging in is not done using a login and password)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue object"
},
"APIIssueAttachment": {
"type": "object",
"properties": {
"FileName": {
"type": "string",
"description": "Original file name",
"nullable": true
},
"ContentType": {
"type": "string",
"description": "Content type",
"nullable": true
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue attachment file"
},
"APIIssueAttachmentResult": {
"type": "object",
"properties": {
"AttachmentId": {
"type": "integer",
"description": "Attachment ID",
"format": "int32"
},
"FileName": {
"type": "string",
"description": "Original file name",
"nullable": true
},
"ContentType": {
"type": "string",
"description": "Content type",
"nullable": true
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue attachment (result operation)"
},
"APIIssueChange": {
"type": "object",
"properties": {
"IssueStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueStatus"
}
],
"description": "Issue status\n\n1 = Open\n\n2 = Close",
"x-enumNames": [
"Open",
"Close"
]
},
"Subject": {
"maxLength": 300,
"type": "string",
"description": "Issue subject",
"nullable": true
},
"Deadline": {
"type": "string",
"description": "Issue deadline",
"format": "date-time",
"nullable": true
},
"IsConfidential": {
"type": "boolean",
"description": "True - issue should be considered as confidential (special permission reguired) \r\nDefault: false"
},
"AccountingYear": {
"type": "string",
"description": "Accounting year to which issue is related",
"nullable": true
},
"Content": {
"type": "string",
"description": "Issue content",
"nullable": true
},
"UserLogin": {
"type": "string",
"description": "Login of the user changing the issue. (Required when logging in is not done using a login and password)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue object for change"
},
"APIIssuePersonRole": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"description": "Issue person role:\r\n\r\n1 - [CompanyOwner] - Company owner\r\n2 - [CompanyManager] - Company manager\r\n3 - [CompanyEmployee] - Company employee\r\n4 - [ChiefAccountant] - Chief accountant\r\n5 - [Accountant] - Accountant\r\n6 - [HumanResources] - Human resources\r\n7 - [HeadAccountant] - Head accountant\n\n1 = CompanyOwner\n\n2 = CompanyManager\n\n3 = CompanyEmployee\n\n4 = ChiefAccountant\n\n5 = Accountant\n\n6 = HumanResources\n\n7 = HeadAccountant",
"format": "int32",
"x-enumNames": [
"CompanyOwner",
"CompanyManager",
"CompanyEmployee",
"ChiefAccountant",
"Accountant",
"HumanResources",
"HeadAccountant"
]
},
"APIIssuePersonRoleIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssuePersonRole"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIIssueResponse": {
"type": "object",
"properties": {
"Content": {
"type": "string",
"description": "Issue response content",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue response"
},
"APIIssueResponseResult": {
"type": "object",
"properties": {
"Content": {
"type": "string",
"description": "Issue response content",
"nullable": true
},
"CreationDate": {
"type": "string",
"description": "Issue response creation date",
"format": "date-time"
},
"CreatedByUser": {
"type": "string",
"description": "Data of the user who created issue response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue response (result operation)"
},
"APIIssueResult": {
"type": "object",
"properties": {
"IssueId": {
"type": "integer",
"description": "Issue ID",
"format": "int32"
},
"IssueStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueStatus"
}
],
"description": "Issue status\n\n1 = Open\n\n2 = Close",
"x-enumNames": [
"Open",
"Close"
]
},
"Subject": {
"maxLength": 300,
"type": "string",
"description": "Issue subject",
"nullable": true
},
"Deadline": {
"type": "string",
"description": "Issue deadline",
"format": "date-time",
"nullable": true
},
"CreationDate": {
"type": "string",
"description": "Creation date of issue",
"format": "date-time"
},
"CreatedByUser": {
"type": "string",
"description": "Data of the user who created issue",
"nullable": true
},
"IsConfidential": {
"type": "boolean",
"description": "True - issue should be considered as confidential (special permission reguired) \r\nDefault: false"
},
"NextResponsePersonRole": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssuePersonRole"
}
],
"description": "Role of the user who should respond next\r\n1 - [CompanyOwner] - Company owner\r\n2 - [CompanyManager] - Company manager\r\n3 - [CompanyEmployee] - Company employee\r\n4 - [ChiefAccountant] - Chief accountant\r\n5 - [Accountant] - Accountant\r\n6 - [HumanResources] - Human resources\r\n7 - [HeadAccountant] - Head accountant\n\n1 = CompanyOwner\n\n2 = CompanyManager\n\n3 = CompanyEmployee\n\n4 = ChiefAccountant\n\n5 = Accountant\n\n6 = HumanResources\n\n7 = HeadAccountant",
"nullable": true
},
"SenderPersonRole": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssuePersonRole"
}
],
"description": " Role of the user who created issue\r\n1 - [CompanyOwner] - Company owner\r\n2 - [CompanyManager] - Company manager\r\n3 - [CompanyEmployee] - Company employee\r\n4 - [ChiefAccountant] - Chief accountant\r\n5 - [Accountant] - Accountant\r\n6 - [HumanResources] - Human resources\r\n7 - [HeadAccountant] - Head accountant\n\n1 = CompanyOwner\n\n2 = CompanyManager\n\n3 = CompanyEmployee\n\n4 = ChiefAccountant\n\n5 = Accountant\n\n6 = HumanResources\n\n7 = HeadAccountant",
"nullable": true
},
"AccountingYear": {
"type": "string",
"description": "Accounting year to which issue is related",
"nullable": true
},
"Content": {
"type": "string",
"description": "Issue content",
"nullable": true
},
"OpenDate": {
"type": "string",
"description": "First open date of issue",
"format": "date-time",
"nullable": true
},
"OpenedByUser": {
"type": "string",
"description": "Data of the user who first open issue",
"nullable": true
},
"AttachmentCount": {
"type": "integer",
"description": "Number of attachments to issue",
"format": "int32"
},
"ResponseCount": {
"type": "integer",
"description": "Number of responses to issue",
"format": "int32"
},
"LastResponseDate": {
"type": "string",
"description": "Date of last issue response",
"format": "date-time",
"nullable": true
},
"LinkToObject": {
"type": "string",
"description": "Object (document, tax) that issue is linked to",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue (result operation)"
},
"APIIssueResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIIssueResultOne": {
"type": "object",
"properties": {
"IssueId": {
"type": "integer",
"description": "Issue ID",
"format": "int32"
},
"IssueStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueStatus"
}
],
"description": "Issue status\n\n1 = Open\n\n2 = Close",
"x-enumNames": [
"Open",
"Close"
]
},
"Subject": {
"maxLength": 300,
"type": "string",
"description": "Issue subject",
"nullable": true
},
"Deadline": {
"type": "string",
"description": "Issue deadline",
"format": "date-time",
"nullable": true
},
"CreationDate": {
"type": "string",
"description": "Creation date of issue",
"format": "date-time"
},
"CreatedByUser": {
"type": "string",
"description": "Data of the user who created issue",
"nullable": true
},
"IsConfidential": {
"type": "boolean",
"description": "True - issue should be considered as confidential (special permission reguired) \r\nDefault: false"
},
"NextResponsePersonRole": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssuePersonRole"
}
],
"description": "Role of the user who should respond next\r\n1 - [CompanyOwner] - Company owner\r\n2 - [CompanyManager] - Company manager\r\n3 - [CompanyEmployee] - Company employee\r\n4 - [ChiefAccountant] - Chief accountant\r\n5 - [Accountant] - Accountant\r\n6 - [HumanResources] - Human resources\r\n7 - [HeadAccountant] - Head accountant\n\n1 = CompanyOwner\n\n2 = CompanyManager\n\n3 = CompanyEmployee\n\n4 = ChiefAccountant\n\n5 = Accountant\n\n6 = HumanResources\n\n7 = HeadAccountant",
"nullable": true
},
"SenderPersonRole": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssuePersonRole"
}
],
"description": " Role of the user who created issue\r\n1 - [CompanyOwner] - Company owner\r\n2 - [CompanyManager] - Company manager\r\n3 - [CompanyEmployee] - Company employee\r\n4 - [ChiefAccountant] - Chief accountant\r\n5 - [Accountant] - Accountant\r\n6 - [HumanResources] - Human resources\r\n7 - [HeadAccountant] - Head accountant\n\n1 = CompanyOwner\n\n2 = CompanyManager\n\n3 = CompanyEmployee\n\n4 = ChiefAccountant\n\n5 = Accountant\n\n6 = HumanResources\n\n7 = HeadAccountant",
"nullable": true
},
"AccountingYear": {
"type": "string",
"description": "Accounting year to which issue is related",
"nullable": true
},
"Content": {
"type": "string",
"description": "Issue content",
"nullable": true
},
"OpenDate": {
"type": "string",
"description": "First open date of issue",
"format": "date-time",
"nullable": true
},
"OpenedByUser": {
"type": "string",
"description": "Data of the user who first open issue",
"nullable": true
},
"AttachmentCount": {
"type": "integer",
"description": "Number of attachments to issue",
"format": "int32"
},
"ResponseCount": {
"type": "integer",
"description": "Number of responses to issue",
"format": "int32"
},
"LastResponseDate": {
"type": "string",
"description": "Date of last issue response",
"format": "date-time",
"nullable": true
},
"LinkToObject": {
"type": "string",
"description": "Object (document, tax) that issue is linked to",
"nullable": true
},
"ClosedBy": {
"type": "string",
"description": "Issue closed by user",
"nullable": true
},
"CloseDate": {
"type": "string",
"description": "Issue close date",
"format": "date-time",
"nullable": true
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueAttachmentResult"
},
"description": "Issue attachments",
"nullable": true
},
"Responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIIssueResponseResult"
},
"description": "Issue responses",
"nullable": true
}
},
"additionalProperties": false,
"description": "Issue (result operation) return by a method that returns a single object"
},
"APIIssueResultOneAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIIssueResultOne"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIIssueStatus": {
"enum": [
1,
2
],
"type": "integer",
"description": "Issue status\r\n\r\n1 - [Open] - Issue open\r\n2 - [Close] - Issue close\n\n1 = Open\n\n2 = Close",
"format": "int32",
"x-enumNames": [
"Open",
"Close"
]
},
"APIItemsAmountCalculateType": {
"enum": [
0,
1
],
"type": "integer",
"description": "Generate invoice from gross or net values:\r\n\r\n0 - [FromNet] - Net values are primary\r\n1 - [FromGross] - Gross values are primary\n\n0 = FromNet\n\n1 = FromGross",
"format": "int32",
"x-enumNames": [
"FromNet",
"FromGross"
]
},
"APILanguageCode": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
-1
],
"type": "integer",
"description": "Language:\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"format": "int32",
"x-enumNames": [
"PL",
"EN",
"DE",
"RU",
"CS",
"FR",
"IT",
"ES",
"UK",
"SV",
"DA",
"FI",
"NB",
"None"
]
},
"APIManualRecord": {
"type": "object",
"properties": {
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIDirectionEnum"
}
],
"description": "Manual record type\r\n\r\n-1 - [Cost] - cost\r\n 1 - [Income] - income\n\n1 = Income\n\n-1 = Cost",
"nullable": true
},
"Date": {
"type": "string",
"description": "Date",
"format": "date-time",
"nullable": true
},
"ContractorName": {
"type": "string",
"description": "Contractor name",
"nullable": true
},
"DocumentNumber": {
"type": "string",
"description": "Document number",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags",
"nullable": true
}
},
"additionalProperties": false,
"description": "Manual record object"
},
"APIManualRecordResult": {
"type": "object",
"properties": {
"ManualRecordId": {
"type": "integer",
"description": "Manual record ID (system generated)",
"format": "int32"
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIDirectionEnum"
}
],
"description": "Manual record type\r\n\r\n-1 - [Cost] - cost\r\n 1 - [Income] - income\n\n1 = Income\n\n-1 = Cost",
"nullable": true
},
"Date": {
"type": "string",
"description": "Date",
"format": "date-time",
"nullable": true
},
"ContractorName": {
"type": "string",
"description": "Contractor name",
"nullable": true
},
"DocumentNumber": {
"type": "string",
"description": "Document number",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags",
"nullable": true
}
},
"additionalProperties": false,
"description": "Manual record result object"
},
"APIManualRecordResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIManualRecordResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIMarginAdditionalType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Dla procedury marzy typ szczegolowy rozbicia procedury VAT MR_UZ\n\n0 = NotApplicable\n\n1 = UsedGoods\n\n2 = WorksOfArt\n\n3 = CollectorsItemsAndAntiques",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"UsedGoods",
"WorksOfArt",
"CollectorsItemsAndAntiques"
]
},
"APINumberPostscript": {
"type": "object",
"properties": {
"NumberPostscript": {
"type": "string",
"description": "Special postscript to invoice number",
"nullable": true
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceType"
}
],
"description": "Invoice type:\r\n\r\n0 - [Invoice] - Invoice with VAT\r\n1 - [InvoiceEU] - EU Invoice with VAT\r\n2 - [Margin] - Margin Invoice\r\n3 - [Bill] - Bill (no VAT)\r\n4 - [ReverseCharge] - Reverse Charge\r\n5 - [Proform] - Proform Invoice\r\n6 - [ProformEU] - EU Proform Invoice\r\n7 - [Correction] - Correction Invoice (not to edit)\r\n8 - [CorrectionEU] - EU Correction Invoice (not to edit)\r\n9 - [Advance] - Advance Invoice (not to edit)\r\n10 - [ReverseChargeCorrection] - Reverse Charge Correction (not to edit)\r\n11 - [BillCorrection] - Bill Correction (not to edit)\r\n12 - [MarginInvoiceCorrection ] - Margin Invoice Correction (not to edit)\r\n13 - [AccountingNote] - Accounting Note\r\n14 - [MarginInvoiceProforma] - MarginInvoice Proforma (not to edit)\n\n0 = Invoice\n\n1 = InvoiceEU\n\n2 = Margin\n\n3 = Bill\n\n4 = ReverseCharge\n\n5 = Proform\n\n6 = ProformEU\n\n7 = Correction\n\n8 = CorrectionEU\n\n9 = Advance\n\n10 = ReverseChargeCorrection\n\n11 = BillCorrection\n\n12 = MarginInvoiceCorrection\n\n13 = AccountingNote\n\n14 = MarginInvoiceProforma",
"nullable": true
}
},
"additionalProperties": false,
"description": "Special postscript to invoice number (i.e. some regulatory explanation)"
},
"APINumberPostscriptIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APINumberPostscript"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIOperatorIdentifierTypeEnum": {
"enum": [
1,
2
],
"type": "integer",
"description": "Operator identifier type enum\r\n\r\n1 - [TaxID] - Tax ID i.e. NIP\r\n2 - [PersonalID] - Personal ID i.e. PESEL\n\n1 = TaxID\n\n2 = PersonalID",
"format": "int32",
"x-enumNames": [
"TaxID",
"PersonalID"
]
},
"APIOperatorTypeEnum": {
"enum": [
1,
2
],
"type": "integer",
"description": "Cash document operator type enum\r\n\r\n1 - [Contractor] - contractor\r\n2 - [Employee] - employee\n\n1 = Contractor\n\n2 = Employee",
"format": "int32",
"x-enumNames": [
"Contractor",
"Employee"
]
},
"APIOrganizationStructureResult": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "Organization structure ID",
"format": "int32"
},
"Name": {
"type": "string",
"description": "Organization structure name",
"nullable": true
},
"UseForPermissionEInvoice": {
"type": "boolean",
"description": "Whether the structure is used for e-invoice permissions"
},
"UseForPermissionEDocuments": {
"type": "boolean",
"description": "Whether the structure is used for e-document permissions"
},
"UseForAcceptEDocuments": {
"type": "boolean",
"description": "Whether the structure is used for document acceptance"
}
},
"additionalProperties": false,
"description": "Organization structure (result operation)"
},
"APIOrganizationStructureResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIOrganizationStructureResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIOverpaymentType": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Tax overpayment type:\r\n\r\n1 - [IsNotOverpayment] - Tax is not an overpayment\r\n2 - [SettleNextMonth] - Tax will be settle next month\r\n3 - [OverpaymentToReturn] - Overpayment for the tax will be returned\n\n1 = IsNotOverpayment\n\n2 = SettleNextMonth\n\n3 = OverpaymentToReturn",
"format": "int32",
"x-enumNames": [
"IsNotOverpayment",
"SettleNextMonth",
"OverpaymentToReturn"
]
},
"APIOwnedByStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "Owned by status enum:\r\n\r\n0 - [NotApplicable] - Not applicable\r\n1 - [YesAddByEmployee] - Yes (added by employee)\r\n2 - [PreliminarilyAssignByOtherUser] - Preliminarily (assign by other user)\r\n3 - [YesConfirmedByEmployee] - Yes (confirmed by employee)\r\n4 - [PreliminarilyAssignByRule] - Preliminarily (assign by rule)\r\n5 - [YesFromKSeF] - Yes (data from invoice from KSeF)\r\n6 - [YesAddedByEmployeeAndFromKSeF] - Yes (added by employee and data from invoice from KSeF)\n\n0 = NotApplicable\n\n1 = YesAddByEmployee\n\n2 = PreliminarilyAssignByOtherUser\n\n3 = YesConfirmedByEmployee\n\n4 = PreliminarilyAssignByRule\n\n5 = YesFromKSeF\n\n6 = YesAddedByEmployeeAndFromKSeF",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"YesAddByEmployee",
"PreliminarilyAssignByOtherUser",
"YesConfirmedByEmployee",
"PreliminarilyAssignByRule",
"YesFromKSeF",
"YesAddedByEmployeeAndFromKSeF"
]
},
"APIPaymentEventDay": {
"type": "object",
"properties": {
"PaymentEventDay": {
"type": "integer",
"description": "Days from the event triggering the payment of invoice",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Days from the event triggering the payment of invoice"
},
"APIPaymentEventDayIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIPaymentEventDay"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIPaymentEventType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "The event triggering the payment of the invoice:\r\n\r\n0 - [DrawnUpDate] - Draw up date\r\n1 - [DeliveryDate] - Delivery date\r\n2 - [CollectionDate] - Collection date\r\n3 - [CollectionOfDocumentDate] - Collection of document date\n\n0 = DrawnUpDate\n\n1 = DeliveryDate\n\n2 = CollectionDate\n\n3 = CollectionOfDocumentDate",
"format": "int32",
"x-enumNames": [
"DrawnUpDate",
"DeliveryDate",
"CollectionDate",
"CollectionOfDocumentDate"
]
},
"APIPaymentForTwoCurrencyType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Payment type of two currency invoice:\r\n\r\n0 - [Netto] - Netto in currency and VAT in base currency\r\n1 - [GrossInCurrency] - Gross in currency\r\n2 - [GrossInBaseCurrency] - Gross in base currency\r\n3 - [GrossInCurrencyOrBaseCurrency] - Gross in currency or gross in base currency\n\n0 = Netto\n\n1 = GrossInCurrency\n\n2 = GrossInBaseCurrency\n\n3 = GrossInCurrencyOrBaseCurrency",
"format": "int32",
"x-enumNames": [
"Netto",
"GrossInCurrency",
"GrossInBaseCurrency",
"GrossInCurrencyOrBaseCurrency"
]
},
"APIPaymentForm": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27
],
"type": "integer",
"description": "Payment form:\r\n\r\n1 - [Cash] - Cach\r\n2 - [BankTransfer] - Bank transfer\r\n3 - [CreditCard] - Credit card\r\n4 - [PaymentCard] - Payment card\r\n5 - [Custom] - Custom\r\n6 - [CashPaid] - Paid by cash\r\n7 - [BankTransferPaid] - Paid by bank transfer\r\n8 - [Compensation] - Compensation\r\n9 - [PaidByElectronicPayment] - Paid by electronic payment\r\n10 - [Barter] - Barter\r\n11 - [PaidByPayPal] - PayPal\r\n12 - [BankTransferOrElectronicPayment] - Bank transfer or electronic payment\r\n13 - [ElectronicPayment] - Electronic payment\r\n14 - [CashOnDelivery] - Cash on delivery\r\n15 - [PaidByStripe] - Stripe\r\n16 - [PaidByAmazon] - Amazon\r\n17 - [PaidByAllegro] - Allegro\r\n18 - [PaidByEtsy] - Etsy\r\n19 - [PaidByArena] - Arena\r\n24 - [Installments] - Installments\r\n25 - [Voucher] - Voucher\r\n26 - [Check] - Check\r\n27 - [PaidByMontonio] - Montonio\n\n1 = Cash\n\n2 = BankTransfer\n\n3 = CreditCard\n\n4 = PaymentCard\n\n5 = Custom\n\n6 = CashPaid\n\n7 = BankTransferPaid\n\n8 = Compensation\n\n9 = PaidByElectronicPayment\n\n10 = Barter\n\n11 = PaidByPayPal\n\n12 = BankTransferOrElectronicPayment\n\n13 = ElectronicPayment\n\n14 = CashOnDelivery\n\n15 = PaidByStripe\n\n16 = PaidByAmazon\n\n17 = PaidByAllegro\n\n18 = PaidByEtsy\n\n19 = PaidByArena\n\n20 = TuristVoucher\n\n21 = PaidByTPay\n\n22 = PaidByPayU\n\n23 = PaidByPrzelewy24\n\n24 = Installments\n\n25 = Voucher\n\n26 = Check\n\n27 = PaidByMontonio",
"format": "int32",
"x-enumNames": [
"Cash",
"BankTransfer",
"CreditCard",
"PaymentCard",
"Custom",
"CashPaid",
"BankTransferPaid",
"Compensation",
"PaidByElectronicPayment",
"Barter",
"PaidByPayPal",
"BankTransferOrElectronicPayment",
"ElectronicPayment",
"CashOnDelivery",
"PaidByStripe",
"PaidByAmazon",
"PaidByAllegro",
"PaidByEtsy",
"PaidByArena",
"TuristVoucher",
"PaidByTPay",
"PaidByPayU",
"PaidByPrzelewy24",
"Installments",
"Voucher",
"Check",
"PaidByMontonio"
]
},
"APIProduct": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 300,
"minLength": 1,
"type": "string",
"description": "Product name"
},
"Unit": {
"maxLength": 20,
"type": "string",
"description": "Product unit",
"nullable": true
},
"NetPrice": {
"type": "number",
"description": "Product net price",
"format": "double",
"nullable": true
},
"GrossPrice": {
"type": "number",
"description": "Product gross price",
"format": "double",
"nullable": true
},
"TaxRate": {
"maxLength": 50,
"type": "string",
"description": "Product tax rate (12%) or label (RC)",
"nullable": true
},
"ProductVATCode": {
"type": "string",
"description": "Optional - goverment VAT Code assigned to this product type",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"DisableAutoUpdate": {
"type": "boolean",
"description": "If true - no updates are made in product catalog after changing product after new/edit invoice operation",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section for product",
"nullable": true
}
},
"additionalProperties": false,
"description": "Product"
},
"APIProductResult": {
"required": [
"Name"
],
"type": "object",
"properties": {
"ProductId": {
"type": "integer",
"description": "Product identifier",
"format": "int32"
},
"Name": {
"maxLength": 300,
"minLength": 1,
"type": "string",
"description": "Product name"
},
"Unit": {
"maxLength": 20,
"type": "string",
"description": "Product unit",
"nullable": true
},
"NetPrice": {
"type": "number",
"description": "Product net price",
"format": "double",
"nullable": true
},
"GrossPrice": {
"type": "number",
"description": "Product gross price",
"format": "double",
"nullable": true
},
"TaxRate": {
"maxLength": 50,
"type": "string",
"description": "Product tax rate (12%) or label (RC)",
"nullable": true
},
"ProductVATCode": {
"type": "string",
"description": "Optional - goverment VAT Code assigned to this product type",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"DisableAutoUpdate": {
"type": "boolean",
"description": "If true - no updates are made in product catalog after changing product after new/edit invoice operation",
"nullable": true
},
"CustomFieldsDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldsDetails"
}
],
"description": "Custom fields section for product",
"nullable": true
}
},
"additionalProperties": false,
"description": "Product [result]"
},
"APIProductResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIProductResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIProductResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIProductResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIProductSet": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Product set name",
"nullable": true
},
"SourceInvoiceNumber": {
"type": "string",
"description": "Source invoice number",
"nullable": true
},
"SourceInvoiceDate": {
"type": "string",
"description": "Source invoice creation date",
"format": "date-time"
},
"SourceInvoiceContractor": {
"type": "string",
"description": "Source invoice contractor name",
"nullable": true
},
"Source": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceSourceType"
}
],
"description": "Type of invoice source \r\n\r\n1 - [ContractorInvoice] - Contractor invoice\r\n2 - [OtherInvoice] - Other invoice\r\n3 - [ProductList] - Product list\n\n1 = ContractorInvoice\n\n2 = OtherInvoice\n\n3 = ProductList",
"x-enumNames": [
"ContractorInvoice",
"OtherInvoice",
"ProductList"
]
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItem"
},
"description": "Items",
"nullable": true
},
"InvoiceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SourceInvoiceDetails"
}
],
"description": "Invoice details",
"nullable": true
}
},
"additionalProperties": false,
"description": "Product set"
},
"APIProductSets": {
"type": "object",
"properties": {
"ProductSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIProductSet"
},
"description": "List of product sets",
"nullable": true
}
},
"additionalProperties": false,
"description": "Product sets"
},
"APIProductSetsAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIProductSets"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIProductUnit": {
"type": "object",
"properties": {
"ProductUnitName": {
"type": "string",
"description": "Product unit name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Product unit"
},
"APIProductUnitIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIProductUnit"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIProductVATCode": {
"type": "object",
"properties": {
"ProductVATCodeName": {
"type": "string",
"description": "Goverment VAT Code name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Goverment VAT Code assigned to product"
},
"APIProductVATCodeIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIProductVATCode"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIProformMode": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "Mode of inclusion of proformas in invoice request:\r\n\r\n0 - [ExcludeProforma] - exclude proforma\r\n1 - [IncludeProforma] - include proforma\r\n2 - [OnlyProforma] - only proforma\n\n0 = ExcludeProforma\n\n1 = IncludeProforma\n\n2 = OnlyProforma",
"format": "int32",
"x-enumNames": [
"ExcludeProforma",
"IncludeProforma",
"OnlyProforma"
]
},
"APIReceiver": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Name"
},
"ContractorReceiverType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorReceiverType"
}
],
"description": "Receiver type \r\n\r\n0 - Standard\r\n1 - JST\r\n2 - VAT Group\r\n3 - Role other\r\n\r\nDefault: Standard\n\n0 = Standard\n\n1 = JST\n\n2 = VatGroup\n\n3 = RoleOther",
"nullable": true
},
"ReceiverIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Receiver identifier type \r\n\r\nnull/0 - [REGON] - REGON\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n4 - [InternalID] - internal ID (f.ex. KSeF internal number)\r\n\r\nDefault: REGON\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Receiver Identifier (optional) i.e. REGON",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City and postal code",
"nullable": true
},
"AddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"CountryCode": {
"maxLength": 200,
"type": "string",
"description": "Country code",
"nullable": true
},
"ContractorId": {
"type": "integer",
"description": "Contractor ID",
"format": "int32",
"nullable": true
},
"ContractorName": {
"maxLength": 200,
"type": "string",
"description": "Contractor Name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Receiver object"
},
"APIReceiverResult": {
"required": [
"Name"
],
"type": "object",
"properties": {
"ReceiverId": {
"type": "integer",
"description": "Receiver ID",
"format": "int32"
},
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Name"
},
"ContractorReceiverType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorReceiverType"
}
],
"description": "Receiver type \r\n\r\n0 - Standard\r\n1 - JST\r\n2 - VAT Group\r\n3 - Role other\r\n\r\nDefault: Standard\n\n0 = Standard\n\n1 = JST\n\n2 = VatGroup\n\n3 = RoleOther",
"nullable": true
},
"ReceiverIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Receiver identifier type \r\n\r\nnull/0 - [REGON] - REGON\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n4 - [InternalID] - internal ID (f.ex. KSeF internal number)\r\n\r\nDefault: REGON\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Receiver Identifier (optional) i.e. REGON",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City and postal code",
"nullable": true
},
"AddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"CountryCode": {
"maxLength": 200,
"type": "string",
"description": "Country code",
"nullable": true
},
"ContractorId": {
"type": "integer",
"description": "Contractor ID",
"format": "int32",
"nullable": true
},
"ContractorName": {
"maxLength": 200,
"type": "string",
"description": "Contractor Name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Receiver object"
},
"APIReceiverResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIReceiverResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIReceiverResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIReceiverResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIReimbursementStatus": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "Reimbursement status enum:\r\n\r\n1 - [NotSettled] - Not settled\r\n2 - [SettledWithCash] - Cash\r\n3 - [SettledWithBankTransfer] - Bank transfer\r\n4 - [PaidByCompanyCard] - Company card\n\n1 = NotSettled\n\n2 = SettledWithCash\n\n3 = SettledWithBankTransfer\n\n4 = PaidByCompanyCard",
"format": "int32",
"x-enumNames": [
"NotSettled",
"SettledWithCash",
"SettledWithBankTransfer",
"PaidByCompanyCard"
]
},
"APIResponse": {
"type": "object",
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response"
},
"APIResponseStatusType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "Response status\r\n\r\n0 - [OK] - Ok status\r\n1 - [Error] - Error status \r\n2 - [Warning] - Warning status\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"format": "int32",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"APISendToKsefMode": {
"enum": [
0,
1,
-1
],
"type": "integer",
"description": "Determines whether the document should be sent to the KSeF system or not 0/null - auto (); 1- always send; -1 - never send\n\n0 = Auto\n\n1 = Send\n\n-1 = DontSend",
"format": "int32",
"x-enumNames": [
"Auto",
"Send",
"DontSend"
]
},
"APITag": {
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/TagGeneral"
}
],
"description": "General information (i.e. name, description, classification)",
"nullable": true
},
"TagGroup": {
"allOf": [
{
"$ref": "#/components/schemas/TagGroup"
}
],
"description": "Tag group",
"nullable": true
},
"TagAccounting": {
"allOf": [
{
"$ref": "#/components/schemas/TagAccounting"
}
],
"description": "Tag accounting data",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tag object"
},
"APITagGroupResult": {
"type": "object",
"properties": {
"TagGroupId": {
"type": "integer",
"description": "Tag group id (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/TagGroupGeneral"
}
],
"description": "General information (i.e. name, description)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tag groups (result operation)"
},
"APITagGroupResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APITagGroupResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITagGroupResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APITagGroupResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITagResult": {
"type": "object",
"properties": {
"TagId": {
"type": "integer",
"description": "Tag ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/TagGeneral"
}
],
"description": "General information (i.e. name, description, classification)",
"nullable": true
},
"TagGroup": {
"allOf": [
{
"$ref": "#/components/schemas/TagGroup"
}
],
"description": "Tag group",
"nullable": true
},
"TagAccounting": {
"allOf": [
{
"$ref": "#/components/schemas/TagAccounting"
}
],
"description": "Tag accounting data",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tags (result operation)"
},
"APITagResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APITagResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITagResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APITagResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITaxResult": {
"type": "object",
"properties": {
"TaxId": {
"type": "integer",
"description": "Tax ID (internal)",
"format": "int32"
},
"General": {
"allOf": [
{
"$ref": "#/components/schemas/TaxGeneral"
}
],
"description": "General information (i.e. number, type, dates)",
"nullable": true
},
"TaxPayer": {
"allOf": [
{
"$ref": "#/components/schemas/TaxPayer"
}
],
"description": "Tax payer",
"nullable": true
},
"TaxPaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/TaxPaymentDetails"
}
],
"description": "Tax payment details",
"nullable": true
},
"TaxAdditionalCosts": {
"allOf": [
{
"$ref": "#/components/schemas/TaxAdditionalCosts"
}
],
"description": "Tax additional costs",
"nullable": true
},
"TaxRecipientDetails": {
"allOf": [
{
"$ref": "#/components/schemas/TaxRecipientDetails"
}
],
"description": "Tax recipient details",
"nullable": true
},
"TaxCorrection": {
"allOf": [
{
"$ref": "#/components/schemas/TaxCorrection"
}
],
"description": "Tax correction details",
"nullable": true
}
},
"additionalProperties": false,
"description": "Taxes (result operation)"
},
"APITaxResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APITaxResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITaxResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APITaxResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITaxType": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "Document type:\r\n\r\n1 - [PersonalCorporateIncomeTax] - Personal income tax/ Corporate income tax\r\n2 - [ValueAddedTax] - Value-added tax (VAT)\r\n3 - [SocialInsurance] - Social insurance\r\n4 - [Others] - Others\n\n1 = PersonalCorporateIncomeTax\n\n2 = ValueAddedTax\n\n3 = SocialInsurance\n\n4 = Others",
"format": "int32",
"x-enumNames": [
"PersonalCorporateIncomeTax",
"ValueAddedTax",
"SocialInsurance",
"Others"
]
},
"APITimesheet": {
"required": [
"TimesheetWorkItem"
],
"type": "object",
"properties": {
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer",
"nullable": true
},
"TimesheetWorkItem": {
"allOf": [
{
"$ref": "#/components/schemas/APITimesheetWorkItem"
}
],
"description": "Timesheet work item"
}
},
"additionalProperties": false,
"description": "Timesheet object"
},
"APITimesheetResult": {
"required": [
"TimesheetWorkItem"
],
"type": "object",
"properties": {
"TimesheetId": {
"type": "integer",
"description": "Timesheet ID (system generated)",
"format": "int32"
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer",
"nullable": true
},
"TimesheetWorkItem": {
"allOf": [
{
"$ref": "#/components/schemas/APITimesheetWorkItem"
}
],
"description": "Timesheet work item"
}
},
"additionalProperties": false,
"description": "Timesheeet object"
},
"APITimesheetResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APITimesheetResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITimesheetResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APITimesheetResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITimesheetWorkItem": {
"required": [
"Amount",
"Date",
"Description"
],
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "Date",
"format": "date-time"
},
"DatePresentationType": {
"allOf": [
{
"$ref": "#/components/schemas/APIDatePresentationTypeEnum"
}
],
"description": "Date presentation type\r\n1 - [FullDate] - Full date \r\n2 - [MonthYear] - Only year and month from date\r\n\r\nDefault: 1 - [FullDate] - Full date\n\n1 = FullDate\n\n2 = MonthYear",
"nullable": true
},
"Description": {
"minLength": 1,
"type": "string",
"description": "Description of work item"
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double"
},
"Unit": {
"maxLength": 20,
"type": "string",
"description": "Unit",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes to work item",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags",
"nullable": true
}
},
"additionalProperties": false,
"description": "Timesheet work item section"
},
"APITreasury": {
"type": "object",
"properties": {
"TreasuryId": {
"type": "integer",
"description": "Treasury ID (system generated)",
"format": "int32"
},
"Name": {
"maxLength": 200,
"type": "string",
"description": "Treasury name",
"nullable": true
},
"ShortName": {
"maxLength": 50,
"type": "string",
"description": "Treasury short name",
"nullable": true
},
"TreasuryCode": {
"maxLength": 50,
"type": "string",
"description": "Treasury code",
"nullable": true
},
"Notes": {
"maxLength": 500,
"type": "string",
"description": "Treasury notes",
"nullable": true
},
"Currency": {
"maxLength": 50,
"type": "string",
"description": "Treasury currency",
"nullable": true
},
"IsDefaultForReimbursement": {
"type": "boolean",
"description": "Is treasury default for employee reimbursement"
}
},
"additionalProperties": false,
"description": "Treasury object"
},
"APITreasuryAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APITreasury"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APITreasuryIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APITreasury"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIUserModuleInfo": {
"type": "object",
"properties": {
"IsModuleActive": {
"type": "boolean",
"description": "Czy moduł aktywny"
},
"CompanyName": {
"type": "string",
"description": "Nazwa firmy",
"nullable": true
},
"IDUser": {
"type": "integer",
"description": "ID użytkownika",
"format": "int32"
},
"UserLogin": {
"type": "string",
"description": "Login użytkownika",
"nullable": true
},
"ModuleName": {
"type": "string",
"description": "Nazwa modułu",
"nullable": true
},
"IsCustomerUser": {
"type": "boolean",
"description": "Czy użytkownik jest pracownikiem klienta (nie biura)"
}
},
"additionalProperties": false,
"description": "Informacja o module użytkownika"
},
"APIUserModuleInfoAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIUserModuleInfo"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIUserResult": {
"type": "object",
"properties": {
"UserId": {
"type": "integer",
"description": "User identifier",
"format": "int32"
},
"Login": {
"type": "string",
"description": "User's login",
"nullable": true
},
"Name": {
"type": "string",
"description": "User's name",
"nullable": true
},
"Surname": {
"type": "string",
"description": "User's surname",
"nullable": true
},
"JobPosition": {
"type": "string",
"description": "User's job position",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "User's phone number",
"nullable": true
},
"MobilePhoneNumber": {
"type": "string",
"description": "User's mobile phone number",
"nullable": true
},
"Email": {
"type": "string",
"description": "User's email",
"nullable": true
},
"IsBlocked": {
"type": "boolean",
"description": "Whether the user is blocked"
}
},
"additionalProperties": false,
"description": "User [result]"
},
"APIUserResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIUserResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIUserResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIUserResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIVATExemptionType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Podstawa zwolnienia od podatku VAT\n\n0 = NotApplicable\n\n1 = VATAct\n\n2 = EUDirectives\n\n3 = OtherLegalBasis",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"VATAct",
"EUDirectives",
"OtherLegalBasis"
]
},
"APIVATProcedures": {
"type": "object",
"properties": {
"VATProcedureName": {
"type": "string",
"description": "VAT procedure name",
"nullable": true
},
"VATProcedureCode": {
"type": "string",
"description": "VAT procedure code",
"nullable": true
}
},
"additionalProperties": false,
"description": "VAT Procedures"
},
"APIVATProceduresIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIVATProcedures"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIVATRate": {
"type": "object",
"properties": {
"VATRateName": {
"type": "string",
"description": "VAT rate name",
"nullable": true
},
"VATRate": {
"type": "number",
"description": "VAT rate value",
"format": "double"
}
},
"additionalProperties": false,
"description": "Vat rate"
},
"APIVATRateIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIVATRate"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIVATStatusCode": {
"enum": [
0,
1,
2,
3,
4,
5,
-2,
-1
],
"type": "integer",
"description": "Contractor status in VAT register:\r\n\r\n-2 - [CannotCheckVATStatus] - No implementation for this Contractor country\r\n-1 - [ErrorWhileCheckingVATStatus] - VAT Register respond with error\r\n0 - [None] - No verification\r\n1 - [VATStatus_OK] - Contractor is active VAT payer\r\n2 - [VATStatus_Exempt] - Contractor is EXEMPT from VAT\r\n3 - [VATStatus_NotRegistered] - Contractor IS NOT REGISTERED for VAT\r\n4 - [WrongTaxID] - VAT ID is wrong\r\n5 - [EmptyTaxID] - VAT ID is empty\n\n0 = None\n\n1 = VATStatus_OK\n\n2 = VATStatus_Exempt\n\n3 = VATStatus_NotRegistered\n\n4 = WrongTaxID\n\n5 = EmptyTaxID\n\n-2 = CannotCheckVATStatus\n\n-1 = ErrorWhileCheckingVATStatus",
"format": "int32",
"x-enumNames": [
"None",
"VATStatus_OK",
"VATStatus_Exempt",
"VATStatus_NotRegistered",
"WrongTaxID",
"EmptyTaxID",
"CannotCheckVATStatus",
"ErrorWhileCheckingVATStatus"
]
},
"APIVehicle": {
"type": "object",
"properties": {
"RegistrationNumber": {
"type": "string",
"description": "Vehicle registration number",
"nullable": true
},
"VIN": {
"type": "string",
"description": "Vehicle VIN number",
"nullable": true
},
"VehicleBrand": {
"type": "string",
"description": "Vehicle brand",
"nullable": true
},
"VehicleModel": {
"type": "string",
"description": "Vehicle model",
"nullable": true
},
"VehicleType": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleTypeEnum"
}
],
"description": "Vehicle type\r\n\r\n1 - [Car] - car\r\n2 - [Truck] - truck\r\n3 - [Motorcycle] - motorcycle\n\n1 = Car\n\n2 = Truck\n\n3 = Motorcycle",
"nullable": true
},
"FuelType": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleFuelTypeEnum"
}
],
"description": "Vehicle fuel type\r\n\r\n1 - [Diesel] - diesel\r\n2 - [Petrol] - petrol \r\n3 - [PetrolWithLPG] - petrol + LPG \r\n4 - [Hybrid] - hybrid\r\n5 - [Electric] - electric \r\n6 - [Hydrogen] - hydrogen\n\n1 = Diesel\n\n2 = Petrol\n\n3 = PetrolWithLPG\n\n4 = Hybrid\n\n5 = Electric\n\n6 = Hydrogen",
"nullable": true
},
"EngineCapacity": {
"type": "number",
"description": "Engine capacity [cm3]",
"format": "double",
"nullable": true
},
"Power": {
"type": "number",
"description": "Power [kW]",
"format": "double",
"nullable": true
},
"ProductionYear": {
"type": "integer",
"description": "Production year",
"format": "int32",
"nullable": true
},
"FirstRegistrationDate": {
"type": "string",
"description": "First registration date",
"format": "date-time",
"nullable": true
},
"InsuranceExpirationDate": {
"type": "string",
"description": "Insurance expiration date",
"format": "date-time",
"nullable": true
},
"TechnicalExaminationExpirationDate": {
"type": "string",
"description": "Technical examination expiration date",
"format": "date-time",
"nullable": true
},
"PurchaseDate": {
"type": "string",
"description": "Purchase date",
"format": "date-time",
"nullable": true
},
"UserId": {
"type": "integer",
"description": "Vehicle manager: IDUser in Taxxo Platform",
"format": "int32",
"nullable": true
},
"VehicleUsagePurpose": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleUsagePurposeEnum"
}
],
"description": "Vehicle usage purpose\r\n\r\n1 - [CompanyForBusiness] - company vehicle used for business purposes\r\n2 - [CompanyForBusinessAndPrivate] - company vehicle used for business and private purposes\r\n3 - [PrivateForBusiness] - private vehicle used for business purposes\r\n\r\nDefault: 2 - [FullDCompanyForBusinessAndPrivateate] - company vehicle used for business and private purposes\n\n1 = CompanyForBusiness\n\n2 = CompanyForBusinessAndPrivate\n\n3 = PrivateForBusiness",
"nullable": true
},
"FinancingMethod": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleFinancingMethodEnum"
}
],
"description": "Vehicle financing method\r\n\r\n1 - [OperatingLeasing] - operating leasing\r\n2 - [FinancialLeasing] - financial leasing\r\n3 - [OwnFundsOrCredit] - own funds or credit\r\n\r\nDefault: 3 - [OwnFundsOrCredit] - own funds or credit\n\n1 = OperatingLeasing\n\n2 = FinancialLeasing\n\n3 = OwnFundsOrCredit",
"nullable": true
},
"VehicleNetPrice": {
"type": "number",
"description": "Vehicle net price",
"format": "double",
"nullable": true
},
"VehicleGrossPrice": {
"type": "number",
"description": "Vehicle gross price",
"format": "double",
"nullable": true
},
"VehicleCostRatio": {
"type": "number",
"description": "Vehicle cost ratio\r\n\r\nDefault: 1,00",
"format": "double",
"nullable": true
},
"AgreementNumber": {
"type": "string",
"description": "Agreement number",
"nullable": true
},
"Account": {
"type": "string",
"description": "Account number used in booking cost transactions with this vehicle",
"nullable": true
},
"IsDisabled": {
"type": "boolean",
"description": "Is vehicle disabled",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Notes to vehicle",
"nullable": true
}
},
"additionalProperties": false,
"description": "Vehicle object"
},
"APIVehicleFinancingMethodEnum": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Vehicle financing method enum\r\n\r\n1 - [OperatingLeasing] - operating leasing\r\n2 - [FinancialLeasing] - financial leasing\r\n3 - [OwnFundsOrCredit] - own funds or credit\n\n1 = OperatingLeasing\n\n2 = FinancialLeasing\n\n3 = OwnFundsOrCredit",
"format": "int32",
"x-enumNames": [
"OperatingLeasing",
"FinancialLeasing",
"OwnFundsOrCredit"
]
},
"APIVehicleFuelTypeEnum": {
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "Vehicle fuel type enum\r\n\r\n1 - [Diesel] - diesel\r\n2 - [Petrol] - petrol \r\n3 - [PetrolWithLPG] - petrol + LPG \r\n4 - [Hybrid] - hybrid\r\n5 - [Electric] - electric \r\n6 - [Hydrogen] - hydrogen\n\n1 = Diesel\n\n2 = Petrol\n\n3 = PetrolWithLPG\n\n4 = Hybrid\n\n5 = Electric\n\n6 = Hydrogen",
"format": "int32",
"x-enumNames": [
"Diesel",
"Petrol",
"PetrolWithLPG",
"Hybrid",
"Electric",
"Hydrogen"
]
},
"APIVehicleResult": {
"type": "object",
"properties": {
"Mileage": {
"type": "integer",
"description": "Mileage",
"format": "int32",
"nullable": true
},
"VehicleId": {
"type": "integer",
"description": "Vehicle ID (system generated)",
"format": "int32"
},
"RegistrationNumber": {
"type": "string",
"description": "Vehicle registration number",
"nullable": true
},
"VIN": {
"type": "string",
"description": "Vehicle VIN number",
"nullable": true
},
"VehicleBrand": {
"type": "string",
"description": "Vehicle brand",
"nullable": true
},
"VehicleModel": {
"type": "string",
"description": "Vehicle model",
"nullable": true
},
"VehicleType": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleTypeEnum"
}
],
"description": "Vehicle type\r\n\r\n1 - [Car] - car\r\n2 - [Truck] - truck\r\n3 - [Motorcycle] - motorcycle\n\n1 = Car\n\n2 = Truck\n\n3 = Motorcycle",
"nullable": true
},
"FuelType": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleFuelTypeEnum"
}
],
"description": "Vehicle fuel type\r\n\r\n1 - [Diesel] - diesel\r\n2 - [Petrol] - petrol \r\n3 - [PetrolWithLPG] - petrol + LPG \r\n4 - [Hybrid] - hybrid\r\n5 - [Electric] - electric \r\n6 - [Hydrogen] - hydrogen\n\n1 = Diesel\n\n2 = Petrol\n\n3 = PetrolWithLPG\n\n4 = Hybrid\n\n5 = Electric\n\n6 = Hydrogen",
"nullable": true
},
"EngineCapacity": {
"type": "number",
"description": "Engine capacity [cm3]",
"format": "double",
"nullable": true
},
"Power": {
"type": "number",
"description": "Power [kW]",
"format": "double",
"nullable": true
},
"ProductionYear": {
"type": "integer",
"description": "Production year",
"format": "int32",
"nullable": true
},
"FirstRegistrationDate": {
"type": "string",
"description": "First registration date",
"format": "date-time",
"nullable": true
},
"InsuranceExpirationDate": {
"type": "string",
"description": "Insurance expiration date",
"format": "date-time",
"nullable": true
},
"TechnicalExaminationExpirationDate": {
"type": "string",
"description": "Technical examination expiration date",
"format": "date-time",
"nullable": true
},
"PurchaseDate": {
"type": "string",
"description": "Purchase date",
"format": "date-time",
"nullable": true
},
"UserId": {
"type": "integer",
"description": "Vehicle manager: IDUser in Taxxo Platform",
"format": "int32",
"nullable": true
},
"VehicleUsagePurpose": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleUsagePurposeEnum"
}
],
"description": "Vehicle usage purpose\r\n\r\n1 - [CompanyForBusiness] - company vehicle used for business purposes\r\n2 - [CompanyForBusinessAndPrivate] - company vehicle used for business and private purposes\r\n3 - [PrivateForBusiness] - private vehicle used for business purposes\r\n\r\nDefault: 2 - [FullDCompanyForBusinessAndPrivateate] - company vehicle used for business and private purposes\n\n1 = CompanyForBusiness\n\n2 = CompanyForBusinessAndPrivate\n\n3 = PrivateForBusiness",
"nullable": true
},
"FinancingMethod": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleFinancingMethodEnum"
}
],
"description": "Vehicle financing method\r\n\r\n1 - [OperatingLeasing] - operating leasing\r\n2 - [FinancialLeasing] - financial leasing\r\n3 - [OwnFundsOrCredit] - own funds or credit\r\n\r\nDefault: 3 - [OwnFundsOrCredit] - own funds or credit\n\n1 = OperatingLeasing\n\n2 = FinancialLeasing\n\n3 = OwnFundsOrCredit",
"nullable": true
},
"VehicleNetPrice": {
"type": "number",
"description": "Vehicle net price",
"format": "double",
"nullable": true
},
"VehicleGrossPrice": {
"type": "number",
"description": "Vehicle gross price",
"format": "double",
"nullable": true
},
"VehicleCostRatio": {
"type": "number",
"description": "Vehicle cost ratio\r\n\r\nDefault: 1,00",
"format": "double",
"nullable": true
},
"AgreementNumber": {
"type": "string",
"description": "Agreement number",
"nullable": true
},
"Account": {
"type": "string",
"description": "Account number used in booking cost transactions with this vehicle",
"nullable": true
},
"IsDisabled": {
"type": "boolean",
"description": "Is vehicle disabled",
"nullable": true
},
"Notes": {
"type": "string",
"description": "Notes to vehicle",
"nullable": true
}
},
"additionalProperties": false,
"description": "Vehicle result object"
},
"APIVehicleResultAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/APIVehicleResult"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIVehicleResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIVehicleResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"APIVehicleTypeEnum": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Vehicle type enum\r\n\r\n1 - [Car] - car\r\n2 - [Truck] - truck\r\n3 - [Motorcycle] - motorcycle\n\n1 = Car\n\n2 = Truck\n\n3 = Motorcycle",
"format": "int32",
"x-enumNames": [
"Car",
"Truck",
"Motorcycle"
]
},
"APIVehicleUsagePurposeEnum": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "Vehicle usage purpose enum\r\n\r\n1 - [CompanyForBusiness] - company vehicle used for business purposes\r\n2 - [CompanyForBusinessAndPrivate] - company vehicle used for business and private purposes\r\n3 - [PrivateForBusiness] - private vehicle used for business purposes\n\n1 = CompanyForBusiness\n\n2 = CompanyForBusinessAndPrivate\n\n3 = PrivateForBusiness",
"format": "int32",
"x-enumNames": [
"CompanyForBusiness",
"CompanyForBusinessAndPrivate",
"PrivateForBusiness"
]
},
"AbsenceDetails": {
"type": "object",
"properties": {
"DateFrom": {
"type": "string",
"description": "Start date of absence",
"format": "date-time",
"nullable": true
},
"DateTo": {
"type": "string",
"description": "End date of absence",
"format": "date-time",
"nullable": true
},
"DurationHours": {
"type": "number",
"description": "Total hours of absence",
"format": "double",
"nullable": true
},
"DurationDays": {
"type": "number",
"description": "Total days of absence",
"format": "double",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description or reason",
"nullable": true
}
},
"additionalProperties": false,
"description": "Absence details (duration/description)"
},
"AbsenceGeneral": {
"type": "object",
"properties": {
"AbsenceType": {
"allOf": [
{
"$ref": "#/components/schemas/APIAbsenceRequestTypeEnum"
}
],
"description": "Type of absence (vacation, sick leave, etc.)\n\n1 = VacationLeave\n\n2 = LeaveOnDemand\n\n3 = SpecialLeave\n\n4 = UnpaidLeave\n\n6 = MaternityLeave\n\n8 = PaternityLeave\n\n9 = ParentalLeave\n\n10 = ChildcareLeave\n\n11 = CaregiverLeave\n\n12 = OtherLeave\n\n14 = ServiseSuspensionUnpaid\n\n15 = ServiseSuspensionPaid",
"x-enumNames": [
"VacationLeave",
"LeaveOnDemand",
"SpecialLeave",
"UnpaidLeave",
"MaternityLeave",
"PaternityLeave",
"ParentalLeave",
"ChildcareLeave",
"CaregiverLeave",
"OtherLeave",
"ServiseSuspensionUnpaid",
"ServiseSuspensionPaid"
]
},
"RequestStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIAbsenceRequestStatusEnum"
}
],
"description": "Current status of request (accepted, rejected, etc.)\n\n0 = Waiting\n\n1 = Accepted\n\n2 = Rejected\n\n3 = Registered\n\n4 = ToClarify\n\n5 = WaitingForVerification",
"nullable": true
},
"Flag": {
"type": "integer",
"description": "Optional internal flag",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "General section"
},
"AcceptanceInfo": {
"type": "object",
"properties": {
"AcceptedByUserId": {
"type": "integer",
"description": "Accepted by user ID",
"format": "int32",
"nullable": true
},
"AcceptedByUserLogin": {
"type": "string",
"description": "Accepted by login",
"nullable": true
},
"AcceptanceDate": {
"type": "string",
"description": "Date of acceptance",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Acceptance info"
},
"AccountingRule": {
"type": "object",
"properties": {
"IDAccountingRule": {
"type": "integer",
"description": "ID zasady księgowości",
"format": "int32"
},
"AccountingRuleName": {
"maxLength": 100,
"type": "string",
"description": "Nazwa zasady księgowości, np. Księgi handlowe",
"nullable": true
},
"AccountingRuleShortcut": {
"maxLength": 100,
"type": "string",
"description": "Skrót zasady księgowości, np. KH",
"nullable": true
},
"Notes": {
"maxLength": 200,
"type": "string",
"description": "Uwagi, np. pole enumeratora",
"nullable": true
},
"Visible_IDTaxCountries": {
"maxLength": 50,
"type": "string",
"description": "identyfikatory krajów podatkowych oddzielone średnikami, dla których widoczne są dane formy księgowania",
"nullable": true
},
"EntityID": {
"type": "integer",
"description": "Uniwersalne ID obiektu",
"format": "int32",
"readOnly": true
},
"___IDCustomer": {
"type": "integer",
"description": "zapisany IDCustomera w formularzu edycyjnym aby była zgodność podczas zapisu",
"format": "int32"
},
"FilterItem_AdditionalInfo": {
"description": "dodatkowe dane filtru",
"nullable": true
},
"FilterItem_GroupName": {
"type": "string",
"description": "grupa do ktorej nalezy element filtru",
"nullable": true
},
"FilterItem_IsDefault": {
"type": "boolean",
"description": "czy element filtru jest domyslny"
},
"FilterItem_Name": {
"type": "string",
"description": "nazwa elementu filtrus",
"nullable": true
},
"FilterItem_Value": {
"description": "wartosc elementu filtru",
"nullable": true
},
"___IsFromDB": {
"type": "boolean",
"description": "Ustawiane podczas odczytu obiektu z bazy danych - jezeli obiekt pochodzi z serializacji z UI powinien miec false\r\nDzieki temu jezeli potrzebujemy historyczny obiekt wiemy czy musimy go pobierac z bazy (jezeli =true) czy wystarczy z cache(=false)"
}
},
"additionalProperties": false,
"description": " Obiekt biznesowy bazujący na Meta_Dict_AccountingRules {tabela}\r\n\r\n Opis źródla danych:\r\n Słownik zasad ksiegowania, np. KH, KPiR\r\n\r\n Modyfikacje:\r\n\t\t- wygenerowano AUTOMATYCZNIE [SQL v.1.26]"
},
"AccountingRuleIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountingRule"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"AccountsArrayPostResponse": {
"type": "object",
"properties": {
"AccountId": {
"type": "string",
"nullable": true
},
"AdditionalData": {
"type": "object",
"additionalProperties": { },
"nullable": true
}
},
"additionalProperties": false
},
"Additional": {
"type": "object",
"properties": {
"CycleId": {
"type": "integer",
"description": "Source CycleID or Null if invoice not created from cycle.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Additional read-only information"
},
"AdditionalDetails": {
"type": "object",
"properties": {
"Url": {
"type": "string",
"description": "File download Url\r\n(requires user login to access)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Additional details section"
},
"AdvanceDetails": {
"type": "object",
"properties": {
"TotalAdvanceAmount": {
"type": "number",
"description": "Total advance amount",
"format": "double"
},
"PaidAmount": {
"type": "number",
"description": "Paid amount",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Advance section"
},
"AisCallbackResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"nullable": true
},
"UserId": {
"type": "string",
"nullable": true
},
"BankId": {
"type": "string",
"nullable": true
},
"Accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountsArrayPostResponse"
},
"nullable": true
},
"AdditionalData": {
"type": "object",
"additionalProperties": { },
"nullable": true
}
},
"additionalProperties": false
},
"AllocationByTag": {
"type": "object",
"properties": {
"Rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllocationTagRows"
},
"description": "Allocation by tag lines",
"nullable": true
}
},
"additionalProperties": false,
"description": "Profit/cost allocation of document"
},
"AllocationDetails": {
"type": "object",
"properties": {
"Rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllocationRows"
},
"description": "Allocation lines",
"nullable": true
}
},
"additionalProperties": false,
"description": "Profit/cost allocation of document"
},
"AllocationDetailsWithKey": {
"type": "object",
"properties": {
"Rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllocationRows"
},
"description": "Allocation lines",
"nullable": true
},
"AllocationKeyId": {
"type": "integer",
"description": "Allocation key id (system generated)",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Profit/cost allocation of document with key"
},
"AllocationGeneral": {
"type": "object",
"properties": {
"Cost": {
"type": "number",
"description": "Cost",
"format": "double",
"nullable": true
},
"Income": {
"type": "number",
"description": "Income",
"format": "double",
"nullable": true
},
"Result": {
"type": "number",
"description": "Result",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Allocation general information"
},
"AllocationRows": {
"type": "object",
"properties": {
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"Description": {
"type": "string",
"description": "Row description",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Line amount",
"format": "double",
"nullable": true
},
"Percent": {
"type": "number",
"description": "Line percent (of total document)",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Single line/row of document cost/profit allocation"
},
"AllocationTagRows": {
"type": "object",
"properties": {
"Tag": {
"type": "string",
"description": "Tag name\r\n\r\nFor no tag - \"-\"",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Single line/row of document allocation by tag"
},
"AllowedContextInfo": {
"type": "object",
"properties": {
"DisplayName": {
"type": "string",
"description": "nazwa kontekstu",
"nullable": true
},
"IDCustomer": {
"type": "integer",
"description": "id uzytkownika na ktorego mozemy zmienic (jezeli zalogowany pracownik biura)",
"format": "int32",
"nullable": true
},
"IDUser": {
"type": "integer",
"description": "id uzytkownika na jakiego mozemy zmienic -> jezeli sa polaczone konta",
"format": "int32",
"nullable": true
},
"IsActiveDigitalization": {
"type": "boolean",
"description": "Czy ma aktywną digitalizację"
},
"CanSaveSourceDocument": {
"type": "boolean",
"description": "Czy ma uprawnienia do zapisu e-dokumentu"
},
"CanReadTaxes": {
"type": "boolean",
"description": "Czy ma uprawnienia do widzialności modułu podatków"
},
"CanReadIssues": {
"type": "boolean",
"description": "Czy ma uprawnienia do widzialności modułu spraw"
},
"CanReadInvoices": {
"type": "boolean",
"description": "Czy ma uprawnienia do widzialności modułu e-faktury"
},
"CanReadInvoicesAfterKSeF": {
"type": "boolean",
"description": "Czy ma uprawnienia do widzialności modułu e-faktury"
},
"CanUseReimbursement": {
"type": "boolean",
"description": "Czy ma uprawnienia do widzialnosci modulu rozliczen z pracownikami"
},
"CanUsePersonel": {
"type": "boolean",
"description": "Czy ma uprawnienia do widzialnosci modulu Porsonel (tylko dodawanie, edycja, tylko moje)"
},
"CanAcceptInPersonel": {
"type": "boolean",
"description": "Czy ma uprawnienia do akceptowania wnioskow urlopowych w widoku personelu"
},
"EAFAccessLevel": {
"type": "integer",
"description": "czy uzytkownik ma prawo uzywac e-analiz Finansowych 0-nie;25-tylko odczyt;100-pelny dostep",
"format": "int32"
},
"IndividualReportsAccessLevel": {
"type": "integer",
"description": "poziom dostepu o raportow indywidualnych 0-brak;25-tylko odczyt;100-pelny dostep",
"format": "int32"
},
"IsTurnOnEprojects": {
"type": "boolean",
"description": "czy e-projekty na kliencie sa wlaczone"
},
"CustomerServiceLevel": {
"allOf": [
{
"$ref": "#/components/schemas/APICustomerServiceLevel"
}
],
"description": "Customer service level:\r\n\r\n-1 - [None] - Lack of any services\r\n0 - [Mini] - Free package (clients without an office) - with limits\r\n1 - [Start] - Start package (free for office clients) - with limits\r\n2 - [Standard] - Standard package\r\n3 - [Premium] - Premium package\r\n4 - [Power] - Power package\r\n5 - [Ultra] - Ultra package\r\n6 - [Ultimate] - Ultimate package\n\n0 = Mini\n\n1 = Start\n\n2 = Standard\n\n3 = Premium\n\n4 = Power\n\n5 = Ultra\n\n6 = Ultimate\n\n-1 = None",
"x-enumNames": [
"Mini",
"Start",
"Standard",
"Premium",
"Power",
"Ultra",
"Ultimate",
"None"
]
},
"Currency": {
"type": "string",
"description": "Customer currency",
"nullable": true
},
"CanUseTransactionTypes": {
"type": "boolean",
"description": "Can use transaction types on invoice"
},
"DefaultNumberPostscripts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Default special postscripts to invoice number",
"nullable": true
},
"BlockAddNewProductOnInvoice": {
"type": "boolean",
"description": "Block adding new product on invoice"
},
"InvoiceProductEditOnUIMode": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceProductEditModeEnum"
}
],
"description": "What to do with product if it is change during editing invoice\n\n1 = Ask\n\n2 = AlwaysUpdate\n\n3 = DoNotUpdate",
"x-enumNames": [
"Ask",
"AlwaysUpdate",
"DoNotUpdate"
]
},
"ReimbursementAdvanceAmount": {
"type": "number",
"description": "Advance amount used in reimbursement",
"format": "double",
"nullable": true
},
"CanUseAbsenceAttachments": {
"type": "boolean",
"description": "Check if user can use Personal Management and see Absence Attachments",
"nullable": true
},
"CanAcceptAbsenceAttachments": {
"type": "boolean",
"description": "Check if user can accept Absence Attachments within Personal Management module",
"nullable": true
},
"ChangeContextOutcomeType": {
"allOf": [
{
"$ref": "#/components/schemas/ChangeContextOutcomeTypeEnum"
}
],
"description": "Info about ability to change to this context from previous one (connected with authentication requirements)\n\n0 = NoOp\n\n1 = Allowed\n\n2 = RequireMfaChallenge\n\n3 = RequireSsoReauth\n\n4 = Blocked",
"x-enumNames": [
"NoOp",
"Allowed",
"RequireMfaChallenge",
"RequireSsoReauth",
"Blocked"
]
},
"ChangeContextOutcomeReason": {
"type": "string",
"description": "The reason of negative change context status",
"nullable": true
},
"CanCustomerSendInvoicesToKsef": {
"type": "boolean",
"description": "Can Customer send invoices to KSeF"
},
"CanUserSendInvoicesToKsef": {
"type": "boolean",
"description": "Can user send invoices to KSeF"
},
"IsKsefConfigComplete": {
"type": "boolean",
"description": "Has KSeF configuration with permission for sending and reading documents from KSeF"
}
},
"additionalProperties": false,
"description": "Opis:\r\n dostepne podczas polaczenia API konteksty na ktore mozna zmienic\r\n \r\nPowiazania:\r\n Internal API\r\n\r\nModyfikacja:\r\n 2017-10-20 PaS - opisanie"
},
"AllowedContextInfoListAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllowedContextInfo"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"AppearanceDetails": {
"type": "object",
"properties": {
"Language": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Generate invoice in selected language:\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\r\n\r\nOptional. Get account country language as default.\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
},
"SecondLanguage": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Optional. To generate invoice in two languages select code of second language.\r\n\r\n-1 - [None] - None - overwrites default values\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\r\n\r\nEmpty (default) - generate invoice in one language\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
}
},
"additionalProperties": false,
"description": "Appearance section"
},
"BankAccountDetails": {
"required": [
"BankAccountNumber"
],
"type": "object",
"properties": {
"BankAccountNumber": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Bank account number"
},
"BankName": {
"maxLength": 100,
"type": "string",
"description": "Bank name",
"nullable": true
},
"SWIFT": {
"maxLength": 50,
"type": "string",
"description": "SWIFT",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bank account"
},
"BooleanAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "boolean",
"description": "Response data"
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"BuyerDetails": {
"type": "object",
"properties": {
"BuyerName": {
"maxLength": 200,
"type": "string",
"description": "Buyer Name",
"nullable": true
},
"BuyerId": {
"type": "integer",
"description": "Buyer ID (optional)",
"format": "int32",
"nullable": true
},
"BuyerIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Buyer identifier type \r\n\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n10 - [NoIdentificationMethod] - no identifier specified\r\n\r\nDefault: TaxID\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"BuyerIdentifier": {
"maxLength": 50,
"type": "string",
"description": "Buyer Identifier\r\nType based on BuyerIdentifierType",
"nullable": true
},
"BuyerAddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"BuyerAddressCity": {
"maxLength": 200,
"type": "string",
"description": "City and postal code",
"nullable": true
},
"BuyerAddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"BuyerCountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"GlobalLocationNumber": {
"maxLength": 200,
"type": "string",
"description": "Global Location Number (GLN)\r\n \r\nOptional. Default empty.",
"nullable": true
},
"BuyerEmail": {
"maxLength": 500,
"type": "string",
"description": "Buyer email\r\n \r\nOptional. Default empty.",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
}
},
"additionalProperties": false,
"description": "Buyer section"
},
"BuyerNotificationSection": {
"type": "object",
"properties": {
"Email": {
"type": "string",
"description": "Email adress",
"nullable": true
},
"Message": {
"type": "string",
"description": "Optional message included in email",
"nullable": true
},
"Language": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Notification Langauge\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
}
},
"additionalProperties": false,
"description": "Buyer notification section"
},
"ByteArrayAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "string",
"description": "Response data",
"format": "byte",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"ChangeContextOutcomeTypeEnum": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "Typ wyniku walidacji zmiany kontekstu\n\n0 = NoOp\n\n1 = Allowed\n\n2 = RequireMfaChallenge\n\n3 = RequireSsoReauth\n\n4 = Blocked",
"format": "int32",
"x-enumNames": [
"NoOp",
"Allowed",
"RequireMfaChallenge",
"RequireSsoReauth",
"Blocked"
]
},
"ClarificationInfo": {
"type": "object",
"properties": {
"ToClarifyUserId": {
"type": "integer",
"description": "User ID who marked to clarify",
"format": "int32",
"nullable": true
},
"ToClarifyUserLogin": {
"type": "string",
"description": "Login who marked to clarify",
"nullable": true
},
"ToClarifyDate": {
"type": "string",
"description": "Date when marked to clarify",
"format": "date-time",
"nullable": true
},
"ToClarifyComment": {
"type": "string",
"description": "Clarification request comment",
"nullable": true
},
"ClarificationDate": {
"type": "string",
"description": "Date of clarification",
"format": "date-time",
"nullable": true
},
"ClarificationComment": {
"type": "string",
"description": "Clarification comment",
"nullable": true
}
},
"additionalProperties": false,
"description": "Clarification info"
},
"ConfigParam": {
"type": "object",
"properties": {
"ParamName": {
"maxLength": 500,
"type": "string",
"description": "Artybut ParamName",
"nullable": true
},
"ParamValue": {
"maxLength": 2000,
"type": "string",
"description": "Artybut ParamValue",
"nullable": true
},
"___IsFromDB": {
"type": "boolean",
"description": "Ustawiane podczas odczytu obiektu z bazy danych - jezeli obiekt pochodzi z serializacji z UI powinien miec false\r\nDzieki temu jezeli potrzebujemy historyczny obiekt wiemy czy musimy go pobierac z bazy (jezeli =true) czy wystarczy z cache(=false)"
}
},
"additionalProperties": false,
"description": " Obiekt biznesowy bazujący na Meta_Config_GetParameters20 {funkcja}\r\n\r\n Opis źródla danych:\r\n (brak)\r\n\r\n Modyfikacje:\r\n\t\t- wygenerowano AUTOMATYCZNIE [SQL v.1.26]"
},
"ConfigParamIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigParam"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"ContextInfo": {
"type": "object",
"properties": {
"CustomerName": {
"type": "string",
"description": "Customer Name",
"nullable": true
},
"AccountingOfficeName": {
"type": "string",
"description": "Accounting Office Name (if applicable)",
"nullable": true
},
"UserLogin": {
"type": "string",
"description": "User Login",
"nullable": true
},
"UserName": {
"type": "string",
"description": "User name",
"nullable": true
},
"UserSurname": {
"type": "string",
"description": "User Surname",
"nullable": true
},
"UserEmail": {
"type": "string",
"description": "User email",
"nullable": true
},
"IDCustomer": {
"type": "integer",
"description": "Customer ID",
"format": "int32",
"nullable": true
},
"IDUser": {
"type": "integer",
"description": "User ID",
"format": "int32",
"nullable": true
},
"IDAccountingOffice": {
"type": "integer",
"description": "Accounting Office ID (if applicable)",
"format": "int32",
"nullable": true
},
"CustomerNIP": {
"type": "string",
"description": "Customer VAT ID",
"nullable": true
},
"CustomerStreet": {
"type": "string",
"description": "Customer Street",
"nullable": true
},
"CustomerHouseNo": {
"type": "string",
"description": "Customer House No",
"nullable": true
},
"CustomerFlatNo": {
"type": "string",
"description": "Customer Flat No",
"nullable": true
},
"StreetWithHouseFlat": {
"type": "string",
"description": "Adress line",
"nullable": true,
"readOnly": true
},
"PostCode": {
"type": "string",
"description": "Post code",
"nullable": true
},
"City": {
"type": "string",
"description": "City",
"nullable": true
},
"CityWithPostCode": {
"type": "string",
"description": "City with post-code",
"nullable": true,
"readOnly": true
},
"Country": {
"type": "string",
"description": "Country",
"nullable": true
},
"Currency": {
"type": "string",
"description": "Customer currency",
"nullable": true
},
"CanAcceptDocuments": {
"type": "boolean",
"description": "Can user accept documents"
},
"UserFlag": {
"type": "integer",
"description": "User custom flag",
"format": "int32",
"nullable": true
},
"IsSuperUser": {
"type": "boolean",
"description": "Is internal operation allowed",
"readOnly": true
},
"HostName": {
"type": "string",
"description": "Front-end server name",
"nullable": true
},
"ClientIP": {
"type": "string",
"description": "Caller IP adress",
"nullable": true
},
"ClientASN": {
"type": "string",
"description": "Caller ASN from IP adress",
"nullable": true
},
"CustomerServiceLevel": {
"allOf": [
{
"$ref": "#/components/schemas/APICustomerServiceLevel"
}
],
"description": "Customer service level:\r\n\r\n-1 - [None] - Lack of any services\r\n0 - [Mini] - Free package (clients without an office) - with limits\r\n1 - [Start] - Start package (free for office clients) - with limits\r\n2 - [Standard] - Standard package\r\n3 - [Premium] - Premium package\r\n4 - [Power] - Power package\r\n5 - [Ultra] - Ultra package\r\n6 - [Ultimate] - Ultimate package\n\n0 = Mini\n\n1 = Start\n\n2 = Standard\n\n3 = Premium\n\n4 = Power\n\n5 = Ultra\n\n6 = Ultimate\n\n-1 = None",
"x-enumNames": [
"Mini",
"Start",
"Standard",
"Premium",
"Power",
"Ultra",
"Ultimate",
"None"
]
},
"CanUseTransactionTypes": {
"type": "boolean",
"description": "Can use transaction types on invoice"
},
"DefaultNumberPostscripts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Default special postscripts to invoice number",
"nullable": true
},
"CanCreateIssue": {
"type": "boolean",
"description": "Can add, edit issue or add response to issue"
},
"CanAccessConfidentialIssues": {
"type": "boolean",
"description": "Can add, edit confidential issue or add response to confidential issue"
},
"CanCreateInvoice": {
"type": "boolean",
"description": "Can add, edit invoice (legacy - will be removed until 2027)"
},
"CanCreateInvoiceAfterKSeF": {
"type": "boolean",
"description": "Can add, edit invoice, with KSeF settings"
},
"IsDelegatedContext": {
"type": "boolean",
"description": "Is delegation of privileges active"
},
"ReimbursementAdvanceAmount": {
"type": "number",
"description": "Advance amount used in reimbursement",
"format": "double",
"nullable": true
},
"CanUseAbsenceAttachments": {
"type": "boolean",
"description": "Check if user can use Personal Management and see Absence Attachments",
"nullable": true
},
"CanAcceptAbsenceAttachments": {
"type": "boolean",
"description": "Check if user can accept Absence Attachments within Personal Management module",
"nullable": true
},
"CanCustomerSendInvoicesToKsef": {
"type": "boolean",
"description": "Can Customer send invoices to KSeF",
"nullable": true
},
"CanUserSendInvoicesToKsef": {
"type": "boolean",
"description": "Can user send invoices to KSeF",
"nullable": true
},
"KsefDocumentsLimitInfo": {
"allOf": [
{
"$ref": "#/components/schemas/LimitationInfo"
}
],
"description": "KSeF limits for documents (used/total)",
"nullable": true
},
"KsefInvoicesLimitInfo": {
"allOf": [
{
"$ref": "#/components/schemas/LimitationInfo"
}
],
"description": "KSeF limits for invoices (used/total)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Information from user and customer context"
},
"ContextInfoAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/ContextInfo"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"CurrencyDetails": {
"type": "object",
"properties": {
"Currency": {
"maxLength": 50,
"type": "string",
"description": "Currency code (ISO) i.e. USD, EUR, GBP, PLN",
"nullable": true
},
"ConversionRate": {
"type": "number",
"description": "Conversion rate",
"format": "double",
"nullable": true
},
"ConversionRateDate": {
"type": "string",
"description": "Conversion rate date",
"format": "date-time",
"nullable": true
},
"ConversionRateSource": {
"maxLength": 50,
"type": "string",
"description": "Source for conversion rate (bank table number, etc.)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Currency section"
},
"CustomFieldsDetails": {
"type": "object",
"properties": {
"Fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APICustomField"
},
"description": "Fields information",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom fields section"
},
"CycleGeneral": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Cycle name"
},
"Description": {
"type": "string",
"description": "Cycle description",
"nullable": true
},
"PeriodType": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCyclePeriodType"
}
],
"description": "Cycle period type:\r\n\r\n1 - [Monthly] - Every month\r\n2 - [BiMonthly] - Every two months\r\n3 - [Quarterly] - Every 3 months\r\n4 - [HalfYear] - Every 6 months\r\n5 - [Yearly] - Every 12 months\r\n6 - [Weekly] - Every week\n\n1 = Monthly\n\n2 = BiMonthly\n\n3 = Quarterly\n\n4 = HalfYear\n\n5 = Yearly\n\n6 = Weekly",
"nullable": true
},
"Start": {
"type": "string",
"description": "Cycle start date",
"format": "date-time",
"nullable": true
},
"End": {
"type": "string",
"description": "Cycle end date",
"format": "date-time",
"nullable": true
},
"GenerateHour": {
"type": "integer",
"description": "Optional - hour when invoice is generated (default 8AM)",
"format": "int32",
"nullable": true
},
"GenerateOnlyInWorkingDays": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycleGenerationDays"
}
],
"description": "Generate invoice only at working days (excluded saturdays, sundays and holidays):\r\n\r\n0 - [OnlyWorking] - Generate invoices only on working days\r\n1 - [WorkingAndHolydays] - Generate invoices in all days\n\n0 = OnlyWorking\n\n1 = WorkingAndHolydays",
"nullable": true
},
"GenerationMethod": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycleGenerationMethod"
}
],
"description": "What to do after invoice generation:\r\n\r\n0 - [Print] - Do nothing - i will print or send this email\r\n1 - [Email] - Send invoice via email\n\n0 = Print\n\n1 = Email",
"nullable": true
},
"SellingDateType": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycleSellingDateType"
}
],
"description": "What value should have selling date in generated invoice:\r\n\r\n0 - [InvoiceMadeOutDate] - Same as made-out date\r\n1 - [FirstDayOfMonth] - First day of current month\r\n2 - [LastDayOfMonth] - Last day of previous month\n\n0 = InvoiceMadeOutDate\n\n1 = FirstDayOfMonth\n\n2 = LastDayOfMonth",
"nullable": true
},
"InvoiceAddNotification_TargetTo": {
"maxLength": 500,
"type": "string",
"description": "When invoice generated notify this emails (';' separated)",
"nullable": true
},
"DiscountType": {
"allOf": [
{
"$ref": "#/components/schemas/APIDiscountType"
}
],
"description": "Type of discount given on items\r\n\r\n0 - [Percent] - Discount in percent\r\n1 - [Amount] - Discount in amount\r\n\r\nOptional. Default = Percent\n\n0 = Percent\n\n1 = Amount",
"nullable": true
}
},
"additionalProperties": false,
"description": "General information about cycle"
},
"DecimalNullableAPIBatchExecutionResult": {
"type": "object",
"properties": {
"ExecId": {
"type": "integer",
"description": "Batch execution ID",
"format": "int32"
},
"Result": {
"type": "number",
"description": "Result of batch call",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Generic accounting data batch response"
},
"DecimalNullableAPIBatchExecutionResultIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DecimalNullableAPIBatchExecutionResult"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"DecimalNullableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "number",
"description": "Response data",
"format": "double",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"DeviceType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "Opis:\r\n Lista typow urzadzen laczacych sie z API\r\n \r\nPowiazania:\r\n API Internal\r\n \r\nModyfikacja:\r\n 2017-09-28 PaS - opisanie\n\n0 = Unknown\n\n1 = Android\n\n2 = IOS\n\n3 = Windows",
"format": "int32",
"x-enumNames": [
"Unknown",
"Android",
"IOS",
"Windows"
]
},
"DimensionsDetails": {
"type": "object",
"properties": {
"Dimensions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": { }
},
"description": "Zestaw wymiarow kosztowych uzupelnionych przez proces AI",
"nullable": true
}
},
"additionalProperties": false,
"description": "Szczegoly zwracane przez AI"
},
"DocumentAccountingDetails": {
"type": "object",
"properties": {
"AccountCategoryId": {
"type": "integer",
"description": "Specify method of document Accounting (predefined and custom)\r\nIf specify AccountAssignmentMethod is not being used",
"format": "int32",
"nullable": true
},
"AccountCategoryName": {
"type": "string",
"description": "(optional) If AccountCategoryId sepcified this parameter is omitted\r\n\r\nSpecify NAME of document accounting method.\r\nIf missing - new category is created with default data copied from AccountAssignmentMethod parameter.",
"nullable": true
},
"AccountAssignmentMethod": {
"allOf": [
{
"$ref": "#/components/schemas/APIAccountAssingmentMethod"
}
],
"description": "Method of document accounting - ONLY PREDEFINED \r\n(used when AccountCategoryId is null/empty):\r\n\r\n1 - [PurchaseGeneral] - Purchase(general)\r\n2 - [PurchaseArticle] - Purchase for resale\r\n3 - [PurchaseNoVatDeduction] - Purchase no VAT deduction\r\n4 - [General] - General \r\n5 - [None] - None\r\n6 - [Service] - Purchase of a service\r\n7 - [Asset] - Asset\r\n8 - [PurchaseHalfVatDeduction] - Purchase 50% VAT Deduction (i.e. car costs)\r\n9 - [CostNoTaxDeductionWithVatDeduction] - No TAX Deduction, but VAT Deduction\r\n10 - [CostNoTaxAndVatDeduction] - No TAX and VAT Deduction\n\n1 = PurchaseGeneral\n\n2 = PurchaseArticle\n\n3 = PurchaseNoVatDeduction\n\n4 = General\n\n5 = None\n\n6 = Service\n\n7 = Asset\n\n8 = PurchaseHalfVatDeduction\n\n9 = CostNoTaxDeductionWithVatDeduction\n\n10 = CostNoTaxAndVatDeduction",
"nullable": true
},
"AccMonth": {
"type": "integer",
"description": "Accounting month (in books)",
"format": "int32",
"nullable": true
},
"AccYear": {
"type": "integer",
"description": "Accounting year (in books)",
"format": "int32",
"nullable": true
},
"AccountingDescription": {
"maxLength": 200,
"type": "string",
"description": "Description for booking process",
"nullable": true
},
"AccountingScheme": {
"type": "integer",
"description": "Accounting scheme\r\n0 (default) - \"accrual accounting\"\r\n1 - \"The cash accounting scheme\"",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document accounting detials"
},
"DocumentBankAccountStatusDetails": {
"type": "object",
"properties": {
"StatusCode": {
"allOf": [
{
"$ref": "#/components/schemas/APIBankAccountStatusCode"
}
],
"description": "Result of checking Bank account number vs VatID (on government whitelist):\r\n\r\n-2 - [CannotCheckBankAccountStatus] - No implementation for this process contractor country\r\n-1 - [ErrorWhileCheckingBankAccountStatus] - Government API respond with error\r\n0 - [None] - No verification\r\n1 - [BankAccount_OK_WhiteListed] - Bank account is CORRECT and on the whitelist with specified contractor\r\n2 - [BankAccount_NOT_WhiteListed] - This account is NOT on whitelist or not mapped with specified contractor\r\n4 - [WrongTaxID] - VAT ID is wrong\r\n5 - [EmptyTaxID] - VAT ID is empty\r\n6 - [WrongBankAccount] - Bank account number is invalid\n\n0 = None\n\n1 = BankAccount_OK_WhiteListed\n\n2 = BankAccount_NOT_WhiteListed\n\n4 = WrongTaxID\n\n5 = EmptyTaxID\n\n6 = WrongBankAccount\n\n-2 = CannotCheckBankAccountStatus\n\n-1 = ErrorWhileCheckingBankAccountStatus",
"nullable": true
},
"VerificationDate": {
"type": "string",
"description": "Date of verification bank account in whitelist",
"format": "date-time",
"nullable": true
},
"VerificationSignature": {
"type": "string",
"description": "Additional audit info of verification process",
"nullable": true
}
},
"additionalProperties": false,
"description": "Bank account status section"
},
"DocumentContractorDetails": {
"type": "object",
"properties": {
"Name": {
"maxLength": 200,
"type": "string",
"description": "Contractor name",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Contractor TaxID",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Adress",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City",
"nullable": true
},
"AddressZipCode": {
"maxLength": 10,
"type": "string",
"description": "Zip Code",
"nullable": true
},
"AddressCountry": {
"maxLength": 100,
"type": "string",
"description": "Country",
"nullable": true
},
"BankAccountNumber": {
"maxLength": 50,
"type": "string",
"description": "Bank account number (for payment purposes)",
"nullable": true
},
"BankSWIFT": {
"maxLength": 50,
"type": "string",
"description": "Bank SWIFT number (for internaltion payment purposes)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contractor details"
},
"DocumentCurrencyDetails": {
"type": "object",
"properties": {
"Currency": {
"maxLength": 50,
"type": "string",
"description": "Currency code (ISO) i.e. USD, EUR, GBP, PLN",
"nullable": true
},
"ConversionRate": {
"type": "number",
"description": "Conversion rate",
"format": "double",
"nullable": true
},
"ConversionRateDate": {
"type": "string",
"description": "Conversion rate date",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Currency section"
},
"DocumentDigitalizationDetails": {
"type": "object",
"properties": {
"DigitalizationStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentDigitalizationStatus"
}
],
"description": "Digitalization status:\r\n\r\n1 - [NotToDigitalization] - Do not digitalize\r\n2 - [AwaitingDigitalization] - Awaiting for digitalization service (prosessing not started yet)\r\n3 - [SentToDigitalization] - Sent to digitalization service (in processing)\r\n4 - [Digitalized] - Done\r\n5 - [Error] - Error after digitalization\r\n6 - [Canceled] - Digitalization canceled\r\n7 - [ToVerification] - Document need to be verify after digitalization\r\n8 - [None] - None\n\n1 = NotToDigitalization\n\n2 = AwaitingDigitalization\n\n3 = SentToDigitalization\n\n4 = Digitalized\n\n5 = Error\n\n6 = Canceled\n\n7 = ToVerification\n\n8 = None",
"nullable": true
},
"ErrorMessage": {
"type": "string",
"description": "Digitalizaion error message",
"nullable": true
},
"MyIdentifier": {
"type": "string",
"description": "My company identifier (VAT ID)",
"nullable": true
},
"FullText": {
"type": "string",
"description": "(where applicable) Raw-text extracted from whole document",
"nullable": true
},
"PositionText": {
"type": "string",
"description": "(where applicable) Raw-text extracted from positions section of document",
"nullable": true
},
"FirstPositionText": {
"type": "string",
"description": "(where applicable) Raw-text extracted from first position of document",
"nullable": true
},
"ExternalProcessingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentProcessingStatus"
}
],
"description": "(where applicable) Status of external processing of document after digitalization:\r\n\r\n1 - [NotReady] - Not ready yet - digitalization in progress\r\n2 - [Ready] - Ready to process\r\n3 - [Processed] - Already processed\n\n1 = NotReady\n\n2 = Ready\n\n3 = Processed",
"nullable": true
},
"OCRTags": {
"type": "string",
"description": "(where applicable) externally definied tags found at OCR",
"nullable": true
}
},
"additionalProperties": false,
"description": "Digitalziation section"
},
"DocumentFileDetails": {
"required": [
"Content",
"ContentType",
"FileName"
],
"type": "object",
"properties": {
"FileId": {
"type": "integer",
"description": "File ID (INTERNAL USE)",
"format": "int32",
"nullable": true
},
"FileName": {
"minLength": 1,
"type": "string",
"description": "Original file name"
},
"ContentType": {
"minLength": 1,
"type": "string",
"description": "Content type"
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte"
},
"PagesCount": {
"type": "integer",
"description": "Document page count",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Scanned file section"
},
"DocumentFileDetailsAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentFileDetails"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"DocumentGeneral": {
"type": "object",
"properties": {
"DocumentTypeId": {
"type": "integer",
"description": "Document Type ID (INTERNAL USE)",
"format": "int32",
"nullable": true
},
"DocumentType": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentType"
}
],
"description": "Document Type:\r\n\r\n1 - [SalesInvoice] - Sales invoice\r\n2 - [PurchaseInvoice] - Purchase invoice\r\n3 - [SalesReceipt] - Sales receipt\r\n4 - [PurchaseReceipt] - Purchase receipt\r\n5 - [BankStatement] - Bank statement\r\n6 - [Declaration] - Declaration (i.e. Tax Declaration or SAD)\r\n7 - [CashDocument] - Cash statement \r\n8 - [CivilContract] - Civil contract\r\n9 - [Payroll] - Payroll\r\n10 - [OtherDocument] - Other (any)\r\n11 - [PurchaseInvoiceCorrection] - Purchase invoice correction\r\n12 - [InterestNote] - Interests\r\n13 - [Delegation] - Delegation / business trip\r\n14 - [SalesInvoiceCorrection] - Sales invoice correction\r\n15 - [PersonnelDocument] - HR document\r\n16 - [WorkContract] - Work Contract (HR)\r\n17 - [WorkOfMandate] - Work of Mandate (HR)\r\n18 - [EmploymentContract] - Employment Contract (HR)\r\n19 - [BillForWorkContract] - Bill for Work Contract\r\n20 - [BillForWorkOfMandate] - Bill for Work of Mandate\r\n21 - [SettlementAdvancePayment] - Advance Settlement\r\n22 - [AcceptanceReport] - Acceptance Report / Protocol\r\n23 - [HolidayRequest] - Holiday Request (HR)\r\n24 - [SickLeave] - Sick Leave (HR)\r\n25 - [PurchaseInvoiceResale] - Purchase Invoice - for resale / inventory\r\n26 - [ProformaPurchaseInvoice] - Purchase Invoice - Proforma / Announcement\r\n27 - [DeliveryDocument] - Proof of delivery\r\n28 - [ProformaSalesInvoice] - Sales Invoice - Proform / Announcement\r\n29 - [Agreement] - Agreement (any)\r\n30 - [Policy] - Insurance policy\r\n31 - [AccountingNote] - Accounting note (special accounting document)\r\n32 - [Payment] - Payment\r\n33 - [DemandOfPayment] - Demand of payment\r\n34 - [TransferOrder] - Transfer order\r\n35 - [AccountingNoteDiscretionary] - Accounting note discretionary (special accounting document)\r\n36 - [Contract] - Contract\r\n37 - [FiscalReport] - Fiscal report\r\n38 - [SalesAdvance] - Sales advance\r\n39 - [SalesAdvanceCorrection] - Sales advance correction\r\n40 - [PurchaseAdvance] - Purchase advance\r\n41 - [PurchaseAdvanceCorrection] - Purchase advance correction\r\n-500 - [VirtualNoPermission] - Virutal record - no permission to all documents for reimbursement (read-only)\n\n1 = SalesInvoice\n\n2 = PurchaseInvoice\n\n3 = SalesReceipt\n\n4 = PurchaseReceipt\n\n5 = BankStatement\n\n6 = Declaration\n\n7 = CashDocument\n\n8 = CivilContract\n\n9 = Payroll\n\n10 = OtherDocument\n\n11 = PurchaseInvoiceCorrection\n\n12 = InterestNote\n\n13 = Delegation\n\n14 = SalesInvoiceCorrection\n\n15 = PersonnelDocument\n\n16 = WorkContract\n\n17 = WorkOfMandate\n\n18 = EmploymentContract\n\n19 = BillForWorkContract\n\n20 = BillForWorkOfMandate\n\n21 = SettlementAdvancePayment\n\n22 = AcceptanceReport\n\n23 = HolidayRequest\n\n24 = SickLeave\n\n25 = PurchaseInvoiceResale\n\n26 = ProformaPurchaseInvoice\n\n27 = DeliveryDocument\n\n28 = ProformaSalesInvoice\n\n29 = Agreement\n\n30 = Policy\n\n31 = AccountingNote\n\n32 = Payment\n\n33 = DemandOfPayment\n\n34 = TransferOrder\n\n35 = AccountingNoteDiscretionary\n\n36 = Contract\n\n37 = FiscalReport\n\n-500 = VirtualNoPermission",
"nullable": true
},
"Number": {
"maxLength": 50,
"type": "string",
"description": "Document number",
"nullable": true
},
"CorrectedNumber": {
"maxLength": 50,
"type": "string",
"description": "If document is a corretion - number of original document\r\nNULL/empty otherwise",
"nullable": true
},
"CorrectedDrawnUpDate": {
"type": "string",
"description": "If document is a corretion - creation date of original document\r\nNULL/empty otherwise",
"format": "date-time",
"nullable": true
},
"ExternalDocumentId": {
"maxLength": 50,
"type": "string",
"description": "External document ID (i.e. barcode number)",
"nullable": true
},
"DrawnUpDate": {
"type": "string",
"description": "Document creation date",
"format": "date-time",
"nullable": true
},
"SaleEndDate": {
"type": "string",
"description": "Date that is used for accounting purposes\r\n(i.e. end of sale process)",
"format": "date-time",
"nullable": true
},
"SaleFromDate": {
"type": "string",
"description": "Start date that is used for accounting purposes\r\n(i.e. begin of sale process)\r\nWhen the sale is specified by a single date rather than a date range, SaleFromDate is null and the SaleEndDate date is filled",
"format": "date-time",
"nullable": true
},
"IsDuplicate": {
"type": "boolean",
"description": "If document is a duplicate - true\r\n\r\nNULL/false - not a duplicate",
"nullable": true
},
"DuplicateDate": {
"type": "string",
"description": "If document is a duplicate - duplicate generation date.\r\nNULL/empty otherwise",
"format": "date-time",
"nullable": true
},
"TotalNet": {
"type": "number",
"description": "Total Net / whole document",
"format": "double",
"nullable": true
},
"TotalTax": {
"type": "number",
"description": "Total VAT / whole document",
"format": "double",
"nullable": true
},
"TotalGross": {
"type": "number",
"description": "Total Gross / whole document",
"format": "double",
"nullable": true
},
"ElectronicVersionOnly": {
"type": "boolean",
"description": "True - document exists only in electronic version (there is no \"paper\" original)\r\nDefault: false",
"nullable": true
},
"IsConfidential": {
"type": "boolean",
"description": "True - document should be considered as confidential (special permission reguired)\r\nDefault: false",
"nullable": true
},
"NotToDigitalization": {
"type": "boolean",
"description": "True - Do not digitalize document (works only when adding new document)\r\nDefault: false",
"nullable": true
},
"Notes": {
"maxLength": 2000,
"type": "string",
"description": "Note - can be used to communicate with accounting office",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag list",
"nullable": true
},
"StartDate": {
"type": "string",
"description": "Start date (for agreement etc.)",
"format": "date-time",
"nullable": true
},
"EndDate": {
"type": "string",
"description": "End date (for agreement etc.)",
"format": "date-time",
"nullable": true
},
"ForwardDate": {
"type": "string",
"description": "Foward date - when customer get this document from contractor",
"format": "date-time",
"nullable": true
},
"CarRegistrationNumber": {
"maxLength": 50,
"type": "string",
"description": "Car plates (for car costs)",
"nullable": true
},
"VATProcedures": {
"type": "array",
"items": {
"type": "string"
},
"description": "VAT Procedures",
"nullable": true
},
"ProductVatCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Goverment VAT Code",
"nullable": true
},
"Flag": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentFlagColor"
}
],
"description": "Flag color:\r\n\r\n0 - [NoFlag] - no flag\r\n1 - [Red] - red color\r\n2 - [Orange] - orange color\r\n3 - [Yellow] - yellow color\r\n4 - [Green] - green color\r\n5 - [Violet] - violet color\r\n6 - [Blue] - blue color\r\n7 - [Pink] - pink color\n\n0 = NoFlag\n\n1 = Red\n\n2 = Orange\n\n3 = Yellow\n\n4 = Green\n\n5 = Violet\n\n6 = Blue\n\n7 = Pink",
"nullable": true
},
"OrderNumber": {
"maxLength": 100,
"type": "string",
"description": "Order number\r\nOnly available with the Ultra Package\r\nOptional. Default empty.",
"nullable": true
},
"Direction": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentDirectionType"
}
],
"description": "Document direction (read-only) - base on document type:\r\n\r\n-1 - [Costs] - Costs\r\n0 - [Unknown] - Unknown\r\n1 - [Revenues] - Revenues\n\n0 = Unknown\n\n1 = Revenues\n\n-1 = Costs",
"nullable": true
},
"KsefNumber": {
"type": "string",
"description": "KSeF document number (read-only)",
"nullable": true
},
"KsefDate": {
"type": "string",
"description": "Date of adding the document to KSeF (read-only)",
"format": "date-time",
"nullable": true
},
"KsefStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentKsefStatus"
}
],
"description": "Document KSeF status (read-only):\r\n\r\n0 - [NotApplicable] - not apply to KSeF\r\n1 - [KsefXMLInvoiceDirect] - KSeF invoice, based on KSeF XML\r\n1 - [KsefPDFInvoiceOnline] - KSeF invoice online, identified based on PDF\r\n2 - [KsefPDFInvoiceOffline] - KSeF invoice offline, identified based on PDF\r\n3 - [KsefRelatedDocument] - document related to KSeF invoice\n\n0 = NotApplicable\n\n1 = KsefXMLInvoiceDirect\n\n2 = KsefPDFInvoiceOnline\n\n3 = KsefPDFInvoiceOffline\n\n4 = KsefRelatedDocument",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document general information"
},
"DocumentKsefDetails": {
"type": "object",
"properties": {
"KsefVerificationQRLink": {
"type": "string",
"description": "KSeF invoice verification link",
"nullable": true
},
"KsefCertificateQRLink": {
"type": "string",
"description": "KSeF certificate verification link",
"nullable": true
},
"KsefHash": {
"type": "string",
"description": "KSeF invoice hash",
"nullable": true
},
"KsefIssueDate": {
"type": "string",
"description": "KSeF invoice issue date (P_1 or parsed from KSeF number)",
"format": "date-time",
"nullable": true
},
"KsefSellerNIP": {
"type": "string",
"description": "KSeF invoice seller NIP",
"nullable": true
},
"KsefParentNumber": {
"type": "string",
"description": "KSeF invoice parent number",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document KSeF details section"
},
"DocumentOwnedByDetails": {
"type": "object",
"properties": {
"UserId": {
"type": "integer",
"description": "Employee: IDUser in Taxxo Platform.\r\n\r\nOnly for ULTRA and above service level.",
"format": "int32",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIOwnedByStatus"
}
],
"description": "Owned by status enum:\r\n\r\n0 - [NotApplicable] - Not applicable\r\n1 - [YesAddByEmployee] - Yes (added by employee)\r\n2 - [PreliminarilyAssignByOtherUser] - Preliminarily (assign by other user)\r\n3 - [YesConfirmedByEmployee] - Yes (confirmed by employee)\r\n4 - [PreliminarilyAssignByRule] - Preliminarily (assign by rule)\r\n5 - [YesFromKSeF] - Yes (data from invoice from KSeF)\r\n6 - [YesAddedByEmployeeAndFromKSeF] - Yes (added by employee and data from invoice from KSeF)\r\n\r\nOnly for ULTRA and above service level.\n\n0 = NotApplicable\n\n1 = YesAddByEmployee\n\n2 = PreliminarilyAssignByOtherUser\n\n3 = YesConfirmedByEmployee\n\n4 = PreliminarilyAssignByRule\n\n5 = YesFromKSeF\n\n6 = YesAddedByEmployeeAndFromKSeF",
"nullable": true
},
"UserName": {
"type": "string",
"description": "Employee: name and surname of user in Taxxo Platform\r\nRead-only\r\n\r\nOnly for ULTRA and above service level.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Owned by section."
},
"DocumentPaymentDetails": {
"type": "object",
"properties": {
"PaymentFormType": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentForm"
}
],
"description": "Payment form:\r\n\r\n1 - [Cash] - Cash\r\n2 - [BankTransfer] - Bank transfer\r\n3 - [CreditCard] - Credit card\r\n4 - [PaymentCard] - Payment card\r\n5 - [Custom] - Custom\r\n6 - [CashPaid] - Paid by cash\r\n7 - [BankTransferPaid] - Paid by bank transfer\r\n8 - [Compensation] - Compensation\r\n9 - [PaidByElectronicPayment] - Paid by electronic payment\r\n10 - [Barter] - Barter\r\n11 - [PaidByPayPal] - PayPal\r\n12 - [BankTransferOrElectronicPayment] - Bank transfer or electronic payment\r\n13 - [ElectronicPayment] - Electronic payment\r\n14 - [CashOnDelivery] - Cash on delivery\r\n15 - [PaidByStripe] - Stripe\r\n16 - [PaidByAmazon] - Amazon\r\n17 - [PaidByAllegro] - Allegro\r\n18 - [PaidByEtsy] - Etsy\r\n19 - [PaidByArena] - Arena\r\n20 - [TuristVoucher] - Turist voucher\r\n21 - [PaidByTPay] - Paid by TPay\r\n22 - [PaidByPayU] - Paid by PayU\r\n23 - [PaidByPrzelewy24] - Paid by Przelewy24\r\n24 - [Installments] - Installments\r\n25 - [Voucher] - Voucher\r\n26 - [Check] - Check\r\n27 - [PaidByMontonio] - Montonio7\n\n1 = Cash\n\n2 = BankTransfer\n\n3 = CreditCard\n\n4 = PaymentCard\n\n5 = Custom\n\n6 = CashPaid\n\n7 = BankTransferPaid\n\n8 = Compensation\n\n9 = PaidByElectronicPayment\n\n10 = Barter\n\n11 = PaidByPayPal\n\n12 = BankTransferOrElectronicPayment\n\n13 = ElectronicPayment\n\n14 = CashOnDelivery\n\n15 = PaidByStripe\n\n16 = PaidByAmazon\n\n17 = PaidByAllegro\n\n18 = PaidByEtsy\n\n19 = PaidByArena\n\n20 = TuristVoucher\n\n21 = PaidByTPay\n\n22 = PaidByPayU\n\n23 = PaidByPrzelewy24\n\n24 = Installments\n\n25 = Voucher\n\n26 = Check\n\n27 = PaidByMontonio",
"nullable": true
},
"PaymentDecisionStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentPaymentDecisionStatus"
}
],
"description": "Payment decision status:\r\n\r\n1 - [PaymentWaiting] - Payment waiting (default)\r\n2 - [PaymentAccepted] - Accepted\r\n3 - [PaymentSuspended] - Suspended\r\n4 - [PaymentToClarify] - Something is wrong\r\n5 - [PaymentSentToBank] - Waiting in bank to be accepted or processed\n\n1 = PaymentWaiting\n\n2 = PaymentAccepted\n\n3 = PaymentSuspended\n\n4 = PaymentToClarify\n\n5 = PaymentSentToBank",
"nullable": true
},
"PaidStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentPaidStatus"
}
],
"description": "Is Paid status:\r\n\r\n-1 - [Unknown] - Not set yet (default)\r\n0 - [IsPaidNo] - Not paid\r\n1 - [IsPaidYes] - Paid\r\n2 - [IsPaidNotApplicable] - Not applicable to this document (i.e. Agreement)\n\n0 = IsPaidNo\n\n1 = IsPaidYes\n\n2 = IsPaidNotApplicable\n\n-1 = Unknown",
"nullable": true
},
"PaymentDate": {
"type": "string",
"description": "Payment date",
"format": "date-time",
"nullable": true
},
"PaidAmount": {
"type": "number",
"description": "Paid ammount (for now)",
"format": "double",
"nullable": true
},
"IsSplitPaymentRequired": {
"type": "boolean",
"description": "Document should be paid by split payment method if TRUE",
"nullable": true
},
"LastSettlementDate": {
"type": "string",
"description": "If the document is paid in full, it is the date on which it was finally paid",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payment section"
},
"DocumentReimbursementDetails": {
"type": "object",
"properties": {
"UserId": {
"type": "integer",
"description": "Employee: IDUser in Taxxo Platform.\r\n\r\nOnly for POWER and above service level.",
"format": "int32",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIReimbursementStatus"
}
],
"description": "Reimbursement status:\r\n\r\n1 - [NotSettled] - Cash\r\n2 - [SettledWithCash] - Bank transfer\r\n3 - [SettledWithBankTransfer] - Credit card\r\n\r\nOnly for POWER and above service level.\n\n1 = NotSettled\n\n2 = SettledWithCash\n\n3 = SettledWithBankTransfer\n\n4 = PaidByCompanyCard",
"nullable": true
},
"UserName": {
"type": "string",
"description": "Employee: name and surname of user in Taxxo Platform\r\nRead-only\r\n\r\nOnly for POWER and above service level.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Reimbursement section."
},
"DocumentStatusDetails": {
"type": "object",
"properties": {
"DocumentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIDocumentStatus"
}
],
"description": "Document status:\r\n\r\n1 - [ForAcceptation] - Need acceptation (Accounting office couldn't see this document)\r\n2 - [ForBook] - Ready for booking\r\n3 - [ForBookChanged] - Need booking - document has changed\r\n4 - [Booked] - Booked\r\n5 - [ForBookForWithdrawn] - To withdraw by accounting office\r\n6 - [Withdrawn] - Withdrawn / deleted\r\n7 - [NotAccepted] - Not accepted / rejected\r\n9 - [BookedChanged] - Booked, but has change after that\r\n10 - [Deleted] - Deleted\r\n11 - [Returned] - Returned\r\n13 - [BookedForWithdrawn] - Booked, but user asked for withdraw\r\n14 - [WithdrawnByDigitalization] - Withdrawn by digitalization process (i.e. duplicate)\r\n15 - [ForVerification] - Need Verification (after OCR process)\n\n1 = ForAcceptation\n\n2 = ForBook\n\n3 = ForBookChanged\n\n4 = Booked\n\n5 = ForBookForWithdrawn\n\n6 = Withdrawn\n\n7 = NotAccepted\n\n9 = BookedChanged\n\n10 = Deleted\n\n11 = Returned\n\n13 = BookedForWithdrawn\n\n14 = WithdrawnByDigitalization\n\n15 = ForVerification",
"nullable": true
},
"AcceptanceDate": {
"type": "string",
"description": "Acceptance date\r\n(if. acceptance process is on)",
"format": "date-time",
"nullable": true
},
"IsToClarify": {
"type": "boolean",
"description": "Need clarifiaction?",
"nullable": true
},
"Clarify_Notes": {
"type": "string",
"description": "Notes if document need some clarification",
"nullable": true
},
"WithdrawnDate": {
"type": "string",
"description": "Withdrawn date or null",
"format": "date-time",
"nullable": true
},
"WithdrawnNote": {
"maxLength": 1000,
"type": "string",
"description": "Withdrawn note or null/empty",
"nullable": true
},
"AddedBy": {
"type": "string",
"description": "Information who added document - email address if added by email or user login if added by Taxxo user",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document statuses section"
},
"DocumentTargetToDetails": {
"type": "object",
"properties": {
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "OBSOLETE. TaxID/VatID of customer/account to which this document should be added",
"nullable": true
},
"Signature": {
"maxLength": 50,
"type": "string",
"description": "OBSOLETE. Special signature added to request to prove that this account is allowed to perform this operation",
"nullable": true
}
},
"additionalProperties": false,
"description": "OBSOLETE. Do not use.\r\nSection that provides functionality to add documents to different customer on the Platform.\r\nLeave empty if adding document to Your account.\r\n\r\nExtended permission required. For more information contact us at api@taxxo.app"
},
"DocumentTypeDetails": {
"type": "object",
"properties": {
"InvoiceType": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceType"
}
],
"description": "Invoice type:\r\n\r\n0 - [Invoice] - Invoice with VAT\r\n1 - [InvoiceEU] - EU Invoice with VAT\r\n2 - [Margin] - Margin Invoice\r\n3 - [Bill] - Bill (no VAT)\r\n4 - [ReverseCharge] - Reverse Charge\r\n5 - [Proform] - Proform Invoice\r\n6 - [ProformEU] - EU Proform Invoice\r\n7 - [Correction] - Correction Invoice (not to edit)\r\n8 - [CorrectionEU] - EU Correction Invoice (not to edit)\r\n9 - [Advance] - Advance Invoice (not to edit)\r\n10 - [ReverseChargeCorrection] - Reverse Charge Correction (not to edit)\r\n11 - [BillCorrection] - Bill Correction (not to edit)\r\n12 - [MarginInvoiceCorrection ] - Margin Invoice Correction (not to edit)\r\n13 - [AccountingNote] - Accounting Note (not to edit)\r\n14 - [MarginInvoiceProforma] - MarginInvoice Proforma (not to edit)\n\n0 = Invoice\n\n1 = InvoiceEU\n\n2 = Margin\n\n3 = Bill\n\n4 = ReverseCharge\n\n5 = Proform\n\n6 = ProformEU\n\n7 = Correction\n\n8 = CorrectionEU\n\n9 = Advance\n\n10 = ReverseChargeCorrection\n\n11 = BillCorrection\n\n12 = MarginInvoiceCorrection\n\n13 = AccountingNote\n\n14 = MarginInvoiceProforma",
"nullable": true
},
"ItemsAmountCalculateType": {
"allOf": [
{
"$ref": "#/components/schemas/APIItemsAmountCalculateType"
}
],
"description": "Which prices should be taken to calculation net or gross\r\n\r\n0 - [FromNet] - Net values are primary\r\n1 - [FromGross] - Gross values are primary\r\n\r\nDefault: Net\n\n0 = FromNet\n\n1 = FromGross",
"nullable": true
},
"NumberPostscript": {
"maxLength": 100,
"type": "string",
"description": "Special postscript to invoice number (i.e. some regulatory explanation)\r\n\r\nOptional. Empty by default",
"nullable": true
},
"VATProcedures": {
"type": "array",
"items": {
"type": "string"
},
"description": "VAT Procedures \r\n\r\nOptional. Default empty.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Document type section"
},
"DocumentVATStatusDetails": {
"type": "object",
"properties": {
"StatusCode": {
"allOf": [
{
"$ref": "#/components/schemas/APIVATStatusCode"
}
],
"description": "Result of checking VAT ID (in specific register):\r\n\r\n-2 - [CannotCheckVATStatus] - No implementation for this Contractor country\r\n-1 - [ErrorWhileCheckingVATStatus] - VAT Register respond with error\r\n0 - [None] - No verification\r\n1 - [VATStatus_OK] - Contractor is active VAT payer\r\n2 - [VATStatus_Exempt] - Contractor is EXEMPT from VAT\r\n3 - [VATStatus_NotRegistered] - Contractor IS NOT REGISTERED for VAT\r\n4 - [WrongTaxID] - VAT ID is wrong\r\n5 - [EmptyTaxID] - VAT ID is empty\n\n0 = None\n\n1 = VATStatus_OK\n\n2 = VATStatus_Exempt\n\n3 = VATStatus_NotRegistered\n\n4 = WrongTaxID\n\n5 = EmptyTaxID\n\n-2 = CannotCheckVATStatus\n\n-1 = ErrorWhileCheckingVATStatus",
"nullable": true
},
"VerificationDate": {
"type": "string",
"description": "Date of verification contractor's VAT ID in Register",
"format": "date-time",
"nullable": true
},
"RegisterCode": {
"type": "string",
"description": "Register where VAT ID where checked",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contractor VAT Status section"
},
"ERPConnector": {
"type": "object",
"properties": {
"IDERPConnector": {
"type": "integer",
"description": "Identyfikator konektora do systemu ERP",
"format": "int32"
},
"IDERPConnectorType": {
"type": "integer",
"description": "Identyfikator typu konektora (okresla jakiego roddzaju jest to konektor - zewn/wewn importowy/eksportowy itd)",
"format": "int32",
"nullable": true
},
"IDERPSystem": {
"type": "integer",
"description": "Identyfikator systemu ERP, którego dotyczy zadany konektor",
"format": "int32"
},
"ERPConnectorName": {
"maxLength": 200,
"type": "string",
"description": "Nazwa konektora (wyświetlana)",
"nullable": true
},
"ERPSystemVersion": {
"maxLength": 200,
"type": "string",
"description": "Numer wersji systemu ERP do którego przeznaczony jest konektor (wyświetalny)",
"nullable": true
},
"ConnectorDefinition": {
"type": "string",
"description": "Definicja konektora w formacie SETL, przechowywane w formacie XML.",
"nullable": true
},
"IsEnabled": {
"type": "boolean",
"description": "Czy zadany konektor jest włączony. Wyłączony(FALSE) konektor nie może być uruchamiany"
},
"IsVisible": {
"type": "boolean",
"description": "Czy zadany konektor jest wyświetlany na liście wyboru użytkowników."
},
"IsDefault": {
"type": "boolean",
"description": "Czy dany konektor jest dla danego systemu i typu domyslnym (1) czy tez nie (0)"
},
"IsTechnical": {
"type": "boolean",
"description": "Czy konektor jest techniczny/ tymczasowy (wykorzystyway wewnętrznie m.in. dla sprowadzenia struktur źródłowych z docelowego ERP/FK)"
},
"InfoMessage": {
"maxLength": 500,
"type": "string",
"description": "Opcjonalny - dla procesów wewnętrznych - komunikat jak wykonać proces importowy/eksportowy za pomocą zadanego konektora (np. opis jak wyeksportoać z systemu dane)",
"nullable": true
},
"CheckFormatExpression": {
"maxLength": 500,
"type": "string",
"description": "Opcjonalny - dla wewnętrznych/importowych - sposób wykrywania formatu - zapytanie ktore moze odpowiedzieć czy ten konektor jest właściwy dla tych danych wejściowych",
"nullable": true
},
"Notes": {
"maxLength": 200,
"type": "string",
"description": "Wewnętrzne notatki",
"nullable": true
},
"StaticFilesKey_Help": {
"maxLength": 200,
"type": "string",
"description": "Klucz do pliku statycznego (Meta_Portal_StaticFiles) zawierajacego instrukcję użytkowania konektora",
"nullable": true
},
"StaticFilesKey_AdditionalFile": {
"maxLength": 200,
"type": "string",
"description": "Klucz do pliku statycznego (Meta_Portal_StaticFiles) zawierajacego dodatkowe pliki instalacyjne (np do systemu ERP)",
"nullable": true
},
"IDModule": {
"type": "integer",
"description": "ID modulu do ktorego nalezy ten konektor",
"format": "int32",
"nullable": true
},
"TutorialVideo_URL": {
"type": "string",
"description": "URL do filmiku z instukcją obsługi.",
"nullable": true
},
"IDTaxCountry": {
"type": "integer",
"description": "Na jaki kraj (podatkowy) jest przeznaczony ten konektor - np. Polski",
"format": "int32",
"nullable": true
},
"UNV_AssignmentMode_CanUseOurDefinedSchema": {
"type": "boolean",
"description": "[NIE UZYWANE] Czy jest możliwość wykorzystania schematow Taxxo ?"
},
"UNV_AssignmentMode_CanUseERPDefinedSchema": {
"type": "boolean",
"description": "[NIE UZYWANE] Czy jest możliwość wykorzystania schematów systemu ksiegowego (mapowanych) ?"
},
"UNV_AccountAssgigmentMode_Default": {
"type": "integer",
"description": "[NIE UZYWANE] domyslny tryb: 0-none; 1-EspDefinedSchema 2-AccSystemDefinedSchema",
"format": "int32"
},
"UNV_OurDefinedSchema_CanSet_Ledger_ColumnNo": {
"type": "boolean",
"description": "Czy jest mozliwosc ustawiania kolumny KPIR ?"
},
"UNV_OurDefinedSchema_CanSet_OperationType": {
"type": "boolean",
"description": "Czy jest mozliwosc rozróżniania typu zakupu ?"
},
"UNV_OurDefinedSchema_CanSet_VatDeduction": {
"type": "boolean",
"description": "Czy jest mozliwosc ustawiania % odliczania vat ?"
},
"UNV_OurDefinedSchema_CanSet_Description": {
"type": "boolean",
"description": "Czy jest mozliwosc ustawiania opisu ?"
},
"UNV_ERPDefinedSchema_CanLinkBy_SchemaName": {
"type": "boolean",
"description": "Czy pierwszy parametr definiowany w konektorze jest widoczny"
},
"UNV_ERPDefinedSchema_CanLinkBy_DocSymbol": {
"type": "boolean",
"description": "Czy drugi parametr definiowany w konektorze jest widoczny"
},
"UNV_ERPDefinedSchema_CanSet_OwnDescription": {
"type": "boolean",
"description": "[NIE UZYWANE] Czy po mapowaniu ze schematem systemu ksiegowego jest jeszcze mozliwosc wpisania wlasnego opisu ?"
},
"UNV_ERPDefinedSchema_LinkParamTitle": {
"maxLength": 500,
"type": "string",
"description": "nazwa parametru mapujacego ktora widzi uzytkownik na ui - wartosc z UNV_ERPDefinedSchema_CanLinkBy_SchemaName",
"nullable": true
},
"UNV_ERPDefinedSchema_LinkParamTitle2_DocSymbol": {
"maxLength": 500,
"type": "string",
"description": "nazwa drugiego parametru mapujacego ktora widzi uzytkownik na ui - wartosc z UNV_ERPDefinedSchema_CanLinkBy_DocSymbol",
"nullable": true
},
"UNV_RequiresFKContractors": {
"type": "boolean",
"description": "Czy konektor UNV wymaga integracji bazy klientów z FK do prawidłowego działania",
"nullable": true
},
"UNV_HasImplementedAccountingMethods20": {
"type": "boolean",
"description": "Czy jest implementacja metod ksiegowania z TX 2.0",
"nullable": true
},
"UNV_CanUseForeignCurrency": {
"type": "boolean",
"description": "Czy konektor obsluguje dokumenty walutowe ?",
"nullable": true
},
"QuickStart_HtmlContentKey": {
"maxLength": 50,
"type": "string",
"description": "tx 2.0 klucz do html content z krótkim info jak korzytsać z konektora",
"nullable": true
},
"ConnectorGuid": {
"maxLength": 50,
"type": "string",
"description": "GUID dla connectora - uzywany m.in. przy automatycznym wdrazaniu konektorow",
"nullable": true
},
"Category_InfoMessage": {
"type": "string",
"description": "Komentarz wyświetlany w oknie konfiguracji kategorii dla konektora danego typu.",
"nullable": true
},
"UNV_ERPDefinedSchema_LinkParamType": {
"type": "integer",
"description": "typ parametru (SchemaName) ustawianego w konfiguracji: 0-dowolny tekst;dodanie 1,2 - odpowiedniki w tabeli ModelC_AccCategories, ew ujemne dla innych (jak plan kont itp)",
"format": "int32",
"nullable": true
},
"UNV_ERPDefinedSchema_LinkParamType2_DocSymbol": {
"type": "integer",
"description": "typ parametru (DocSymbol) ustawianego w konfiguracji: 0-dowolny tekst;dodanie 1,2 - odpowiedniki w tabeli ModelC_AccCategories, ew ujemne dla innych (jak plan kont itp)",
"format": "int32",
"nullable": true
},
"UNV_NoFileNeeded": {
"type": "boolean",
"description": "Jezeli true - nie pytamy o plik przy paczkach",
"nullable": true
},
"UNV_OurDefinedSchema_CanSet_CostDeduction": {
"type": "boolean",
"description": "Czy jest mozliwosc ustawiania % odliczania KUP ?",
"nullable": true
},
"UNV_ERPDefinedSchema_CanLinkBy_General3": {
"type": "boolean",
"description": "Czy trzeci parametr definiowany w konektorze jest widoczny",
"nullable": true
},
"UNV_ERPDefinedSchema_LinkParamTitle_General3": {
"maxLength": 500,
"type": "string",
"description": "nazwa trzeciego parametru mapujacego ktora widzi uzytkownik na ui - wartosc z UNV_ERPDefinedSchema_CanLinkBy_General3",
"nullable": true
},
"UNV_ERPDefinedSchema_LinkParamType_General3": {
"type": "integer",
"description": "typ parametru (General3) ustawianego w konfiguracji: 0-dowolny tekst;dodanie 1,2 - odpowiedniki w tabeli ModelC_AccCategories, ew ujemne dla innych (jak plan kont itp)",
"format": "int32",
"nullable": true
},
"UNV_ERPDefinedSchema_CanLinkBy_PartialCostDeduction": {
"type": "boolean",
"description": "Czy czwarty parametr definiowany w konektorze jest widoczny - uwaga zeby byl widoczny musi na kategorii byc wybrane czesciowe odliczanie KUP/NKUP",
"nullable": true
},
"UNV_ERPDefinedSchema_LinkParamTitle_PartialCostDeduction": {
"maxLength": 500,
"type": "string",
"description": "nazwa czwartego parametru mapujacego ktora widzi uzytkownik na ui - wartosc z UNV_ERPDefinedSchema_CanLinkBy_PartialCostDeduction",
"nullable": true
},
"UNV_ERPDefinedSchema_LinkParamType_PartialCostDeduction": {
"type": "integer",
"description": "typ parametru (PartialCostDeduction) ustawianego w konfiguracji: 0-dowolny tekst;dodanie 1,2 - odpowiedniki w tabeli ModelC_AccCategories, ew ujemne dla innych (jak plan kont itp)",
"format": "int32",
"nullable": true
},
"UNV_ERPDefinedSchema_NameList_General3": {
"maxLength": 500,
"type": "string",
"description": "Jezeli typ dla General3=-1, lista nazw do wyswietlenia w dropdownie na UI oddzielona srednikami",
"nullable": true
},
"UNV_ERPDefinedSchema_ValueList_General3": {
"maxLength": 500,
"type": "string",
"description": "Jezeli typ dla General3=-1, lista ustawianych wartosci odpowiadajacym nazwom do wyswietlenia w dropdownie na UI oddzielona srednikami",
"nullable": true
},
"UNV_ERPDefinedSchema_DefaultValue_General3": {
"maxLength": 100,
"type": "string",
"description": "Jezeli typ dla General3=-1, i nie ustawiono w konfiguracji konektora zadnej wartosci dla general3 - wybierz domyslnie ten element z ta wartoscia",
"nullable": true
},
"UNV_CanNotSetAccountDate": {
"type": "boolean",
"description": "Dotyczy konektorow przelewowych - jezeli konektor NIE moze podac daty na ktory jest przelew (obecnie santander) - zeby mozna bylo wyswielic ostrzezenie",
"nullable": true
},
"EntityID": {
"type": "integer",
"description": "Uniwersalne ID obiektu",
"format": "int32",
"readOnly": true
},
"___IsFromDB": {
"type": "boolean",
"description": "Ustawiane podczas odczytu obiektu z bazy danych - jezeli obiekt pochodzi z serializacji z UI powinien miec false\r\nDzieki temu jezeli potrzebujemy historyczny obiekt wiemy czy musimy go pobierac z bazy (jezeli =true) czy wystarczy z cache(=false)"
}
},
"additionalProperties": false,
"description": " Obiekt biznesowy bazujący na Integration_ERPConnectors {tabela}\r\n\r\n Opis źródla danych:\r\n Lista konektorów do systemów ERP\r\n\r\n Modyfikacje:\r\n\t\t- wygenerowano AUTOMATYCZNIE [SQL v.1.26]"
},
"ERPConnectorIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ERPConnector"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"ExceptionInfo": {
"type": "object",
"properties": {
"DeveloperMessage": {
"type": "string",
"description": "Widomość dewelopera",
"nullable": true
},
"Message": {
"type": "string",
"description": "Wiadomość o błędzie",
"nullable": true
},
"Source": {
"type": "string",
"description": "Źródło",
"nullable": true
},
"StackTrace": {
"type": "string",
"description": "Stack trace",
"nullable": true
}
},
"additionalProperties": false,
"description": "Dane o błędzie s SmartActions"
},
"ExchangeDeviceLoginTokenInputModel": {
"type": "object",
"properties": {
"TokenLabel": {
"type": "string",
"description": "Nazwa tokenu",
"nullable": true
}
},
"additionalProperties": false,
"description": "Input model wymiany DeviceLoginToken na access i refresh token"
},
"FactorDetails": {
"required": [
"BankAccountNumber",
"Name"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 200,
"minLength": 1,
"type": "string",
"description": "Name"
},
"FactorId": {
"type": "integer",
"description": "Factor Id",
"format": "int32",
"nullable": true
},
"IdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Identifier type \r\n\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n10 - [NoIdentificationMethod] - no identifier specified \r\n\r\nDefault: TaxID\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"Identifier": {
"maxLength": 50,
"type": "string",
"description": "Factor Identifier\r\nType based on IdentifierType",
"nullable": true
},
"AddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"AddressCity": {
"maxLength": 200,
"type": "string",
"description": "City",
"nullable": true
},
"AddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"CountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"BankAccountNumber": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Bank account number"
},
"BankAccountSWIFT": {
"maxLength": 50,
"type": "string",
"description": "Bank account SWIFT",
"nullable": true
},
"VATBankAccountNumber": {
"maxLength": 50,
"type": "string",
"description": "Bank account number for VAT payment in base currency",
"nullable": true
},
"VATBankAccountSWIFT": {
"maxLength": 50,
"type": "string",
"description": "Bank account SWIFT for VAT payment in base currency",
"nullable": true
},
"AdditionalInvoiceInfo": {
"type": "string",
"description": "Additional information to be included in the invoice footer\r\n(if left empty, no information will be included).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Factor details - read only"
},
"FactorDetailsBase": {
"type": "object",
"properties": {
"FactorId": {
"type": "integer",
"description": "Factor Id",
"format": "int32",
"nullable": true
},
"AdditionalInvoiceInfo": {
"type": "string",
"description": "Additional information to be included in the invoice footer\r\n(if left empty, no information will be included).",
"nullable": true
}
},
"additionalProperties": false,
"description": "Base class for factor details used for POST and PUT endpoints"
},
"Fido2MakeCredentialOptionsInputModel": {
"type": "object",
"properties": {
"CredentialNickname": {
"type": "string",
"description": "Przyjazna nazwa klucza",
"nullable": true
},
"AttestationType": {
"type": "string",
"description": "Rodzaj poswiadczenia",
"nullable": true
}
},
"additionalProperties": false,
"description": "Input model do rejestracji klucza"
},
"FilePackage": {
"type": "object",
"properties": {
"FileName": {
"type": "string",
"description": "Nazwa przetwarzanego pliku.",
"nullable": true
},
"PackagesCount": {
"type": "integer",
"description": "Ilość paczek.",
"format": "int32"
},
"FileSize": {
"type": "integer",
"description": "Rozmiar pliku w bajtach",
"format": "int64"
},
"PackageBytes": {
"type": "string",
"description": "Zawartość paczki",
"format": "byte",
"nullable": true
},
"PackageNo": {
"type": "integer",
"description": "Numer paczki",
"format": "int32"
},
"Checksum": {
"type": "string",
"description": "Suma kontrolna",
"nullable": true
},
"Barcode": {
"type": "string",
"description": "Kod paskowy",
"nullable": true
}
},
"additionalProperties": false,
"description": "Klasa pojedynczej paczki pliku, przesyłanej do API, np. przez taxxo kuriera"
},
"General": {
"type": "object",
"properties": {
"SeriesCode": {
"maxLength": 10,
"type": "string",
"description": "Code of invoice series\r\n\r\nOptional. Default = general series",
"nullable": true
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceType"
}
],
"description": "Invoice type:\r\n\r\n0 - [Invoice] - Invoice with VAT\r\n1 - [InvoiceEU] - EU Invoice with VAT\r\n2 - [Margin] - Margin Invoice\r\n3 - [Bill] - Bill (no VAT)\r\n4 - [ReverseCharge] - Reverse Charge\r\n5 - [Proform] - Proform Invoice\r\n6 - [ProformEU] - EU Proform Invoice\r\n7 - [Correction] - Correction Invoice (not to edit)\r\n8 - [CorrectionEU] - EU Correction Invoice (not to edit)\r\n9 - [Advance] - Advance Invoice (not to edit)\r\n10 - [ReverseChargeCorrection] - Reverse Charge Correction (not to edit)\r\n11 - [BillCorrection] - Bill Correction (not to edit)\r\n12 - [MarginInvoiceCorrection ] - Margin Invoice Correction (not to edit)\r\n13 - [AccountingNote] - Accounting Note (not to edit)\r\n14 - [MarginInvoiceProforma] - MarginInvoice Proforma (not to edit)\n\n0 = Invoice\n\n1 = InvoiceEU\n\n2 = Margin\n\n3 = Bill\n\n4 = ReverseCharge\n\n5 = Proform\n\n6 = ProformEU\n\n7 = Correction\n\n8 = CorrectionEU\n\n9 = Advance\n\n10 = ReverseChargeCorrection\n\n11 = BillCorrection\n\n12 = MarginInvoiceCorrection\n\n13 = AccountingNote\n\n14 = MarginInvoiceProforma",
"nullable": true
},
"InvoiceStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceStatus"
}
],
"description": "Invoice status:\r\n\r\n0 - [NotApplicable] - KSeF not applicable\r\n1 - [Draft] - Draft\r\n2 - [ReadyToSend] - Ready to send to KSeF\r\n3 - [AwaitingBackJob] - Awaiting automatic sending to KSeF in the background\r\n4 - [IssuedOffline] - Issued offline, awaiting sending to KSeF\r\n5 - [IssuedOffline24] - Issued in Offline24 mode, awaiting sending to KSeF\r\n6 - [XmlImportedAwaitingExternalConfirmation] - Invoice XML retrieved from Taxxo; invoice will be issued and sent to KSeF outside the system by the customer\r\n7 - [Sending] - Sending to KSeF\r\n8 - [SentToKsef] - Sent to KSeF\r\n9 - [KsefError] - KSeF error\r\n10 - [RejectedByKsef] - Rejected by KSeF\r\n11 - [KsefNumberAssigned] - KSeF number assigned\r\n12 - [SourceDocumentsConfirmed] - Confirmed in source document (e-Documents)\r\n13 - [Interrupted] - Sending to KSeF interrupted\r\n14 - [Canceled] - Canceled\n\n0 = NotApplicable\n\n1 = Draft\n\n2 = ReadyToSend\n\n3 = AwaitingBackJob\n\n4 = IssuedOffline\n\n5 = IssuedOffline24\n\n6 = XmlImportedAwaitingExternalConfirmation\n\n7 = Sending\n\n8 = SentToKsef\n\n9 = KsefError\n\n10 = RejectedByKsef\n\n11 = KsefNumberAssigned\n\n12 = SourceDocumentsConfirmed\n\n13 = Interrupted\n\n14 = Canceled",
"x-enumNames": [
"NotApplicable",
"Draft",
"ReadyToSend",
"AwaitingBackJob",
"IssuedOffline",
"IssuedOffline24",
"XmlImportedAwaitingExternalConfirmation",
"Sending",
"SentToKsef",
"KsefError",
"RejectedByKsef",
"KsefNumberAssigned",
"SourceDocumentsConfirmed",
"Interrupted",
"Canceled"
]
},
"IsDraft": {
"type": "boolean",
"description": "Is invoice a draft"
},
"Number": {
"maxLength": 100,
"type": "string",
"description": "Invoice number \r\n\r\nOptional - autogenerated by default",
"nullable": true
},
"NumberPostscript": {
"maxLength": 100,
"type": "string",
"description": "Special postscript to invoice number (i.e. some regulatory explanation)\r\n\r\nOptional. Empty by default",
"nullable": true
},
"MadeOutDate": {
"type": "string",
"description": "Made out date\r\n\r\nOptional. Today as default",
"format": "date-time",
"nullable": true
},
"MadeOutDateMode": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceMadeOutDateMode"
}
],
"description": "Invoice made out date mode - KSeF related\r\n\r\n0 - [Default] - The invoice made out date is set when the invoice is sent to KSeF.\r\n1 - [LastDayOfPreviousMonthOnNextBusinessDay] - Sets the invoice made out date to the last day of the previous month if the invoice is sent to KSeF on the next business day.\n\n0 = Default\n\n1 = LastDayOfPreviousMonthOnNextBusinessDay",
"nullable": true
},
"SellingDate": {
"type": "string",
"description": "SellingDate\r\n\r\nOptional. Today as default",
"format": "date-time",
"nullable": true
},
"ItemsAmountCalculateType": {
"allOf": [
{
"$ref": "#/components/schemas/APIItemsAmountCalculateType"
}
],
"description": "Which prices should be taken to calculation net or gross\r\n\r\n0 - [FromNet] - Net values are primary\r\n1 - [FromGross] - Gross values are primary\r\n\r\nDefault: Net\n\n0 = FromNet\n\n1 = FromGross",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes (visible on invoice)",
"nullable": true
},
"MadeOutBy": {
"maxLength": 200,
"type": "string",
"description": "Person who made out this invoice (printed)\r\n\r\nOptional. Default empty",
"nullable": true
},
"ReceivedBy": {
"maxLength": 200,
"type": "string",
"description": "Person who recieved this invoice\r\n\r\nOptional. Default empty.",
"nullable": true
},
"AutoCreateInvoiceToPaidProform": {
"type": "boolean",
"description": "For proforma there is a possibility to auto-create final invoice after proforma is mark as paid\r\n\r\nOptional. Default false/null",
"nullable": true
},
"OrderNumber": {
"maxLength": 100,
"type": "string",
"description": "Order number\r\n\r\nOptional. Default empty.",
"nullable": true
},
"ContractNumber": {
"maxLength": 100,
"type": "string",
"description": "Contract number\r\n\r\nOptional. Default empty.",
"nullable": true
},
"ContractDate": {
"type": "string",
"description": "Contract date\r\n\r\nOptional. Default empty.",
"format": "date-time",
"nullable": true
},
"VATProcedures": {
"type": "array",
"items": {
"type": "string"
},
"description": "VAT Procedures \r\n\r\nOptional. Default empty.",
"nullable": true
},
"DiscountType": {
"allOf": [
{
"$ref": "#/components/schemas/APIDiscountType"
}
],
"description": "Type of discount given on items\r\n\r\n0 - [Percent] - Discount in percent\r\n1 - [Amount] - Discount in amount\r\n\r\nOptional. Default = Percent\n\n0 = Percent\n\n1 = Amount",
"nullable": true
},
"VATExemptionType": {
"allOf": [
{
"$ref": "#/components/schemas/APIVATExemptionType"
}
],
"description": "Specifies the legal basis for VAT exemption.\r\n\r\n0 - [NotApplicable] - VAT exemption does not apply (default value)\r\n1 - VatAct - VAT exemption based on the national VAT Act\r\n2 - EUDirectives - VAT exemption based on applicable EU Directives\r\n3 - OtherLegalBasis - VAT exemption based on another legal basis\r\n\r\nDefault = NotApplicable\n\n0 = NotApplicable\n\n1 = VATAct\n\n2 = EUDirectives\n\n3 = OtherLegalBasis",
"nullable": true
},
"VATExemptionDetails": {
"maxLength": 200,
"type": "string",
"description": "Provides detailed legal reference for the applied VAT exemption.",
"nullable": true
},
"MarginAdditionalType": {
"allOf": [
{
"$ref": "#/components/schemas/APIMarginAdditionalType"
}
],
"description": "Specifies the detailed type under the VAT margin scheme (MR_UZ procedure).\r\n\r\n0 - NotApplicable - Margin procedure does not apply\r\n1 - UsedGoods - Used goods\r\n2 - WorksOfArt - Works of art\r\n3 - CollectorsItemsAndAntiques - Collectors' items and antiques\r\n\r\nDefault = NotApplicable\n\n0 = NotApplicable\n\n1 = UsedGoods\n\n2 = WorksOfArt\n\n3 = CollectorsItemsAndAntiques",
"nullable": true
}
},
"additionalProperties": false,
"description": "General section"
},
"GeneralCorrection": {
"type": "object",
"properties": {
"Number": {
"maxLength": 100,
"type": "string",
"description": "Invoice number \r\n\r\nOptional - autogenerated by default",
"nullable": true
},
"NumberPostscript": {
"maxLength": 100,
"type": "string",
"description": "Special postscript to invoice number (i.e. some regulatory explanation)\r\n\r\nOptional. Empty by default",
"nullable": true
},
"MadeOutDate": {
"type": "string",
"description": "Made out date\r\n\r\nOptional. Today as default",
"format": "date-time",
"nullable": true
},
"MadeOutDateMode": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceMadeOutDateMode"
}
],
"description": "Invoice made out date mode - KSeF related\r\n\r\n0 - [Default] - The invoice made out date is set when the invoice is sent to KSeF.\r\n1 - [LastDayOfPreviousMonthOnNextBusinessDay] - Sets the invoice made out date to the last day of the previous month if the invoice is sent to KSeF on the next business day.\n\n0 = Default\n\n1 = LastDayOfPreviousMonthOnNextBusinessDay",
"nullable": true
},
"SellingDate": {
"type": "string",
"description": "SellingDate\r\n\r\nOptional. Today as default",
"format": "date-time",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes (visible on invoice)",
"nullable": true
},
"CorrectionReason": {
"maxLength": 200,
"type": "string",
"description": "Correction reason",
"nullable": true
},
"MadeOutBy": {
"maxLength": 200,
"type": "string",
"description": "Person who made out this invoice (printed)\r\n\r\nOptional. Default empty",
"nullable": true
},
"ReceivedBy": {
"maxLength": 200,
"type": "string",
"description": "Person who recieved this invoice\r\n\r\nOptional. Default empty.",
"nullable": true
},
"OrderNumber": {
"maxLength": 100,
"type": "string",
"description": "Order number\r\n\r\nOptional. Default empty.",
"nullable": true
},
"ContractNumber": {
"maxLength": 100,
"type": "string",
"description": "Contract number\r\n\r\nOptional. Default empty.",
"nullable": true
},
"ContractDate": {
"type": "string",
"description": "Contract date\r\n\r\nOptional. Default empty.",
"format": "date-time",
"nullable": true
},
"VATProcedures": {
"type": "array",
"items": {
"type": "string"
},
"description": "VAT Procedures \r\n\r\nOptional. Default empty.",
"nullable": true
}
},
"additionalProperties": false,
"description": "General correction section"
},
"GeneralSeries": {
"type": "object",
"properties": {
"SeriesName": {
"maxLength": 200,
"type": "string",
"description": "Name of invoice series",
"nullable": true
},
"SeriesCode": {
"maxLength": 50,
"type": "string",
"description": "Code of invoice series, if empty general series",
"nullable": true
},
"Language": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Generate invoice in selected language:\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\r\n\r\nOptional. Get account country language as default.\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
},
"SecondLanguage": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Optional. To generate invoice in two languages select code of second language.\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\r\n\r\nEmpty (default) - generate invoice in one language\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
},
"IsActive": {
"type": "boolean",
"description": "Whether the invoice series is active."
},
"CanSaveInvoiceInSeries": {
"type": "boolean",
"description": "Whether the user has the right to issue invoices in this series"
}
},
"additionalProperties": false,
"description": "General series section"
},
"GeneralSourceInvoice": {
"type": "object",
"properties": {
"NumberPostscript": {
"maxLength": 100,
"type": "string",
"description": "Special postscript to invoice number (i.e. some regulatory explanation)\r\n\r\nOptional. Empty by default",
"nullable": true
},
"ItemsAmountCalculateType": {
"allOf": [
{
"$ref": "#/components/schemas/APIItemsAmountCalculateType"
}
],
"description": "Which prices should be taken to calculation net or gross\r\n\r\n0 - [FromNet] - Net values are primary\r\n1 - [FromGross] - Gross values are primary\r\n\r\nDefault: Net\n\n0 = FromNet\n\n1 = FromGross",
"nullable": true
},
"VATProcedures": {
"type": "array",
"items": {
"type": "string"
},
"description": "VAT Procedures \r\n\r\nOptional. Default empty.",
"nullable": true
}
},
"additionalProperties": false,
"description": "General section"
},
"GeneratedInvoicesInfo": {
"type": "object",
"properties": {
"IDFirstInvoice": {
"type": "integer",
"description": "id of first invoice generated from cycle",
"format": "int32",
"nullable": true
},
"FirstInvoiceDate": {
"type": "string",
"description": "first invoice date",
"format": "date-time",
"nullable": true
},
"IDLastInvoice": {
"type": "integer",
"description": "id of last invoice generated from cycle",
"format": "int32",
"nullable": true
},
"LastInvoiceDate": {
"type": "string",
"description": "last invoice date",
"format": "date-time",
"nullable": true
},
"GeneratedInvoicesCount": {
"type": "integer",
"description": "number of generated invoice from cycle\r\n(if manually remove generated invoice, vounter will remain the same)",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "generated invoices info"
},
"HttpStatusCode": {
"enum": [
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
],
"type": "integer",
"description": "\n\n100 = Continue\n\n101 = SwitchingProtocols\n\n102 = Processing\n\n103 = EarlyHints\n\n200 = OK\n\n201 = Created\n\n202 = Accepted\n\n203 = NonAuthoritativeInformation\n\n204 = NoContent\n\n205 = ResetContent\n\n206 = PartialContent\n\n207 = MultiStatus\n\n208 = AlreadyReported\n\n226 = IMUsed\n\n300 = Ambiguous\n\n301 = Moved\n\n302 = Redirect\n\n303 = RedirectMethod\n\n304 = NotModified\n\n305 = UseProxy\n\n306 = Unused\n\n307 = RedirectKeepVerb\n\n308 = PermanentRedirect\n\n400 = BadRequest\n\n401 = Unauthorized\n\n402 = PaymentRequired\n\n403 = Forbidden\n\n404 = NotFound\n\n405 = MethodNotAllowed\n\n406 = NotAcceptable\n\n407 = ProxyAuthenticationRequired\n\n408 = RequestTimeout\n\n409 = Conflict\n\n410 = Gone\n\n411 = LengthRequired\n\n412 = PreconditionFailed\n\n413 = RequestEntityTooLarge\n\n414 = RequestUriTooLong\n\n415 = UnsupportedMediaType\n\n416 = RequestedRangeNotSatisfiable\n\n417 = ExpectationFailed\n\n421 = MisdirectedRequest\n\n422 = UnprocessableEntity\n\n423 = Locked\n\n424 = FailedDependency\n\n426 = UpgradeRequired\n\n428 = PreconditionRequired\n\n429 = TooManyRequests\n\n431 = RequestHeaderFieldsTooLarge\n\n451 = UnavailableForLegalReasons\n\n500 = InternalServerError\n\n501 = NotImplemented\n\n502 = BadGateway\n\n503 = ServiceUnavailable\n\n504 = GatewayTimeout\n\n505 = HttpVersionNotSupported\n\n506 = VariantAlsoNegotiates\n\n507 = InsufficientStorage\n\n508 = LoopDetected\n\n510 = NotExtended\n\n511 = NetworkAuthenticationRequired",
"format": "int32",
"x-enumNames": [
"Continue",
"SwitchingProtocols",
"Processing",
"EarlyHints",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultiStatus",
"AlreadyReported",
"IMUsed",
"Ambiguous",
"Moved",
"Redirect",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"RedirectKeepVerb",
"PermanentRedirect",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"MisdirectedRequest",
"UnprocessableEntity",
"Locked",
"FailedDependency",
"UpgradeRequired",
"PreconditionRequired",
"TooManyRequests",
"RequestHeaderFieldsTooLarge",
"UnavailableForLegalReasons",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported",
"VariantAlsoNegotiates",
"InsufficientStorage",
"LoopDetected",
"NotExtended",
"NetworkAuthenticationRequired"
]
},
"IndividualReportFileDetails": {
"type": "object",
"properties": {
"FileName": {
"type": "string",
"description": "Original file name",
"nullable": true
},
"ContentType": {
"type": "string",
"description": "Content type",
"nullable": true
},
"Content": {
"type": "string",
"description": "Byte array - file content",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": "Individual report file section"
},
"Int32NullableAPIBatchResponse": {
"type": "object",
"properties": {
"BatchData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Int32NullableAPIDataResponse"
},
"description": "Response data for batch requests",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data for batch requests"
},
"Int32NullableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "integer",
"description": "Response data",
"format": "int32",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"IntegrationAccountDataSource": {
"type": "object",
"properties": {
"IDLocalization": {
"type": "integer",
"description": "Identyfikator lokalizacji źródła danych (zewnętrzne)",
"format": "int32"
},
"IDIntegrationAccount": {
"type": "integer",
"description": "Identyfikato kontoa integracyjnego, do którego należy to źródło danych (może być ustawione albo konto integracyjne, albo bezpośrednio klient)",
"format": "int32",
"nullable": true
},
"IDLocalizationType": {
"type": "integer",
"description": "Typ lokalizacji (MSSQL/Folder)",
"format": "int32"
},
"IDCustomer": {
"type": "integer",
"description": "NIE UZYWANE!",
"format": "int32",
"nullable": true
},
"Name": {
"maxLength": 100,
"type": "string",
"description": "Nazwa przyjazna",
"nullable": true
},
"Source": {
"maxLength": 200,
"type": "string",
"description": "Źródło (np. nazwa serwera/IP/nazwa katalogu/zasobu sieciowego)",
"nullable": true
},
"Login": {
"maxLength": 100,
"type": "string",
"description": "Login do żródła danych",
"nullable": true
},
"Password": {
"maxLength": 100,
"type": "string",
"description": "Hasło\r\nHasło",
"nullable": true
},
"IsIntegratedAuthorization": {
"type": "boolean",
"description": "Czy wykorzystać zintegrowane logowanie Windows"
},
"AdditionalParameters": {
"maxLength": 200,
"type": "string",
"description": "Dodatkowe parametry połączeniowe do logowania",
"nullable": true
},
"IsTechnical": {
"type": "boolean",
"description": "Czy ta instancja jest technicznym MSSQL'em? (IDLocalizationType powinno być =1), instancja będzie wykorzystywana do uruchamiania konektorów plikowych"
},
"ExcludedDatabaseList": {
"type": "string",
"description": "Lista baz danych wykluczanych w ramach danej lokalizacji - oddzielonych średnikiem (;) - np aby wyłaczyć bazy kadrowe przy imporcie FK",
"nullable": true
},
"Notes": {
"maxLength": 200,
"type": "string",
"description": "Notatki",
"nullable": true
},
"EntityID": {
"type": "integer",
"description": "Uniwersalne ID obiektu",
"format": "int32",
"readOnly": true
},
"___IDCustomer": {
"type": "integer",
"description": "zapisany IDCustomera w formularzu edycyjnym aby była zgodność podczas zapisu",
"format": "int32"
},
"___IsFromDB": {
"type": "boolean",
"description": "Ustawiane podczas odczytu obiektu z bazy danych - jezeli obiekt pochodzi z serializacji z UI powinien miec false\r\nDzieki temu jezeli potrzebujemy historyczny obiekt wiemy czy musimy go pobierac z bazy (jezeli =true) czy wystarczy z cache(=false)"
}
},
"additionalProperties": false,
"description": " Obiekt biznesowy bazujący na Integration_DataSource_Localizations {tabela}\r\n\r\n Opis źródla danych:\r\n Lista źródeł danych zdefiniowanych u klientów (w biurach rachunkowych) z któych podczas integracji pobierane są dane\r\n\r\n Modyfikacje:\r\n\t\t- wygenerowano AUTOMATYCZNIE [SQL v.1.26]"
},
"IntegrationAccountDataSourceIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationAccountDataSource"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"InterestNoteAppearanceDetails": {
"type": "object",
"properties": {
"Language": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Generate interest note in selected language:\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\r\n\r\nOptional. Get account country language as default.\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
},
"SecondLanguage": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Optional. To generate Interest Note in two languages select code of second language.\r\n\r\n-1 - [None] - None - overwrites default values\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\r\n\r\nEmpty (default) - generate Interest Note in one language\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
}
},
"additionalProperties": false,
"description": "Appearance section"
},
"InterestNoteBuyerDetails": {
"type": "object",
"properties": {
"BuyerName": {
"maxLength": 200,
"type": "string",
"description": "Buyer Name",
"nullable": true
},
"BuyerId": {
"type": "integer",
"description": "Buyer ID (optional)",
"format": "int32",
"nullable": true
},
"BuyerIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Buyer identifier type \r\n\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n10 - [NoIdentificationMethod] - no identifier specified\r\n\r\nDefault: TaxID\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"BuyerIdentifier": {
"maxLength": 50,
"type": "string",
"description": "Buyer Identifier\r\nType based on BuyerIdentifierType",
"nullable": true
},
"BuyerAddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"BuyerAddressCity": {
"maxLength": 200,
"type": "string",
"description": "City and postal code",
"nullable": true
},
"BuyerAddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"BuyerCountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"BuyerEmail": {
"maxLength": 500,
"type": "string",
"description": "Buyer email\r\n \r\nOptional. Default empty.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Buyer section"
},
"InterestNoteCurrencyDetails": {
"type": "object",
"properties": {
"Currency": {
"maxLength": 50,
"type": "string",
"description": "Currency code (ISO) i.e. USD, EUR, GBP, PLN",
"nullable": true
},
"ConversionRate": {
"type": "number",
"description": "Conversion rate",
"format": "double",
"nullable": true
},
"ConversionRateDate": {
"type": "string",
"description": "Conversion rate date",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Currency section"
},
"InterestNoteGeneral": {
"type": "object",
"properties": {
"CustomInterestPercent": {
"type": "number",
"description": "Own (non-statutory) interest rate percentage - only for Ultra+ accounts level",
"format": "double",
"nullable": true
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIInterestType"
}
],
"description": "Interest type:\r\n\r\n0 - [GovermentOverdue] - Governmental interest for overdue payments (to consumer)\r\n1 - [Custom] - Custom/Contractual interest\r\n2 - [Business] - Statutory interest for late payments in business transactions\r\n3 - [BusinessMedical] - Statutory interest for late payments in business transactions (public medical entity)\n\n0 = GovermentOverdue\n\n1 = Custom\n\n2 = Business\n\n3 = BusinessMedical",
"nullable": true
},
"Number": {
"maxLength": 100,
"type": "string",
"description": "Interest Note number \r\n\r\nOptional - autogenerated by default",
"nullable": true
},
"MadeOutDate": {
"type": "string",
"description": "Made out date\r\n\r\nOptional. Today as default",
"format": "date-time",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes (visible on Interest Note)",
"nullable": true
},
"MadeOutBy": {
"maxLength": 200,
"type": "string",
"description": "Person who made out this Interest Note (printed)\r\n\r\nOptional. Default empty",
"nullable": true
}
},
"additionalProperties": false,
"description": "General section"
},
"InterestNoteInternalDetails": {
"type": "object",
"properties": {
"InternalNotes": {
"maxLength": 500,
"type": "string",
"description": "Internal notes. Not printed!\r\n\r\nOptional. Default empty",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags (interest note internal description)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Internal section"
},
"InterestNotePaymentDetails": {
"type": "object",
"properties": {
"PaymentForm": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentForm"
}
],
"description": "Payment form:\r\n\r\n1 - [Cash] - Cash\r\n2 - [BankTransfer] - Bank transfer\r\n3 - [CreditCard] - Credit card\r\n4 - [PaymentCard] - Payment card\r\n5 - [Custom] - Custom\r\n6 - [CashPaid] - Paid by cash\r\n7 - [BankTransferPaid] - Paid by bank transfer\r\n8 - [Compensation] - Compensation\r\n9 - [PaidByElectronicPayment] - Paid by electronic payment\r\n10 - [Barter] - Barter\r\n11 - [PaidByPayPal] - PayPal\r\n12 - [BankTransferOrElectronicPayment] - Bank transfer or electronic payment\r\n13 - [ElectronicPayment] - Electronic payment\r\n14 - [CashOnDelivery] - Cash on delivery\r\n15 - [PaidByStripe] - Stripe\r\n16 - [PaidByAmazon] - Amazon\r\n17 - [PaidByAllegro] - Allegro\r\n18 - [PaidByEtsy] - Etsy\r\n19 - [PaidByArena] - Arena\r\n20 - [TuristVoucher] - Turist voucher\r\n21 - [PaidByTPay] - Paid by TPay\r\n22 - [PaidByPayU] - Paid by PayU\r\n23 - [PaidByPrzelewy24] - Paid by Przelewy24\r\n24 - [Installments] - Installments\r\n25 - [Voucher] - Voucher\r\n26 - [Check] - Check\r\n27 - [PaidByMontonio] - Montonio\n\n1 = Cash\n\n2 = BankTransfer\n\n3 = CreditCard\n\n4 = PaymentCard\n\n5 = Custom\n\n6 = CashPaid\n\n7 = BankTransferPaid\n\n8 = Compensation\n\n9 = PaidByElectronicPayment\n\n10 = Barter\n\n11 = PaidByPayPal\n\n12 = BankTransferOrElectronicPayment\n\n13 = ElectronicPayment\n\n14 = CashOnDelivery\n\n15 = PaidByStripe\n\n16 = PaidByAmazon\n\n17 = PaidByAllegro\n\n18 = PaidByEtsy\n\n19 = PaidByArena\n\n20 = TuristVoucher\n\n21 = PaidByTPay\n\n22 = PaidByPayU\n\n23 = PaidByPrzelewy24\n\n24 = Installments\n\n25 = Voucher\n\n26 = Check\n\n27 = PaidByMontonio",
"nullable": true
},
"BankAccount": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountDetails"
}
],
"description": "Bank account",
"nullable": true
},
"PaymentDeadline": {
"type": "string",
"description": "Due date",
"format": "date-time",
"nullable": true
},
"PaidAmountForNow": {
"type": "number",
"description": "Current paid amount (not printed - for payment processing)",
"format": "double",
"nullable": true
},
"LastSettlementDate": {
"type": "string",
"description": "If the interest note is paid in full, it is the date on which it was finally paid",
"format": "date-time",
"nullable": true
},
"PaymentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/APIInterestNotePaymentStatus"
}
],
"description": "Payment status of the interest note:\r\n0 - [Unpaid] - Unpaid\r\n1 - [Paid] - Paid\r\n2 - [Canceled] - Canceled\n\n0 = Unpaid\n\n1 = Paid\n\n2 = Canceled",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payment section"
},
"InterestNoteSendByEmailParams": {
"required": [
"Email"
],
"type": "object",
"properties": {
"Email": {
"minLength": 1,
"type": "string",
"description": "Email adress"
},
"Message": {
"type": "string",
"description": "Optional message included in email",
"nullable": true
},
"Language": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Send email in specific language (optional):\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
}
},
"additionalProperties": false,
"description": "Send by email command parameters"
},
"InterestNoteSummary": {
"type": "object",
"properties": {
"TotalNet": {
"type": "number",
"description": "Total Net",
"format": "double",
"nullable": true
},
"TotalGross": {
"type": "number",
"description": "Total Gross",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Interest note summary section"
},
"InternalDetails": {
"type": "object",
"properties": {
"InternalNotes": {
"maxLength": 500,
"type": "string",
"description": "Internal notes. Not printed!\r\n\r\nOptional. Default empty",
"nullable": true
},
"Tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags (invoice internal description)",
"nullable": true
},
"Flag": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceFlagColor"
}
],
"description": "Flag color:\r\n\r\n0 - [NoFlag] - no flag\r\n1 - [Red] - red color\r\n2 - [Orange] - orange color\r\n3 - [Yellow] - yellow color\r\n4 - [Green] - green color\r\n5 - [Violet] - violet color\r\n6 - [Blue] - blue color\r\n7 - [Pink] - pink color\n\n0 = NoFlag\n\n1 = Red\n\n2 = Orange\n\n3 = Yellow\n\n4 = Green\n\n5 = Violet\n\n6 = Blue\n\n7 = Pink",
"nullable": true
}
},
"additionalProperties": false,
"description": "Internal section"
},
"InvoiceDetails": {
"required": [
"BuyerDetails",
"Items"
],
"type": "object",
"properties": {
"InvoiceGeneral": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceGeneral"
}
],
"description": "Invoice general section",
"nullable": true
},
"BuyerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDetails"
}
],
"description": "Buyer"
},
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIInvoiceItem"
},
"description": "Invoice items"
},
"CurrencyDetails": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyDetails"
}
],
"description": "Currency",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetails"
}
],
"description": "Payment section",
"nullable": true
},
"ReceiverDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ReceiverDetails"
}
],
"description": "Receiver (optional if other then Buyer)",
"nullable": true
},
"BuyerNotificationSection": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerNotificationSection"
}
],
"description": "Buyer notification section",
"nullable": true
},
"SplitVatDetails": {
"allOf": [
{
"$ref": "#/components/schemas/SplitVATDetails"
}
],
"description": "Split VAT additional section.\r\nIf missing - no split VAT on invoice",
"nullable": true
},
"FactorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/FactorDetailsBase"
}
],
"description": "Factor section",
"nullable": true
},
"AppearanceDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AppearanceDetails"
}
],
"description": "Appearance section",
"nullable": true
},
"InternalDetails": {
"allOf": [
{
"$ref": "#/components/schemas/InternalDetails"
}
],
"description": "Internal section",
"nullable": true
}
},
"additionalProperties": false,
"description": "invoice details"
},
"InvoiceGeneral": {
"type": "object",
"properties": {
"SeriesCode": {
"maxLength": 10,
"type": "string",
"description": "Code of invoice series\r\n\r\nOptional. Default = general series",
"nullable": true
},
"Type": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycleInvoiceType"
}
],
"description": "Invoice type:\r\n\r\n0 - [Invoice] - Invoice with VAT\r\n1 - [InvoiceEU] - EU Invoice with VAT\r\n2 - [Margin] - Margin Invoice\r\n3 - [Bill] - Bill (no VAT)\r\n4 - [ReverseCharge] - Reverse Charge\r\n5 - [Proform] - Proform Invoice\r\n6 - [ProformEU] - EU Proform Invoice\n\n0 = Invoice\n\n1 = InvoiceEU\n\n2 = Margin\n\n3 = Bill\n\n4 = ReverseCharge\n\n5 = Proform\n\n6 = ProformEU",
"nullable": true
},
"SendToKSeFMode": {
"allOf": [
{
"$ref": "#/components/schemas/APISendToKsefMode"
}
],
"description": "Determines whether the document should be sent to the KSeF system:\r\n\r\n0 / null - Automatic (based on customer and buyer settings)\r\n1 - Always send to KSeF\r\n-1 - Never send to KSeF\n\n0 = Auto\n\n1 = Send\n\n-1 = DontSend",
"nullable": true
},
"IsDraft": {
"type": "boolean",
"description": "Is invoice a draft"
},
"Number": {
"maxLength": 100,
"type": "string",
"description": "Invoice number \r\n\r\nOptional - autogenerated by default",
"nullable": true
},
"NumberPostscript": {
"maxLength": 100,
"type": "string",
"description": "Special postscript to invoice number (i.e. some regulatory explanation)\r\n\r\nOptional. Empty by default",
"nullable": true
},
"MadeOutDate": {
"type": "string",
"description": "Made out date\r\n\r\nOptional. Today as default",
"format": "date-time",
"nullable": true
},
"SellingDate": {
"type": "string",
"description": "SellingDate\r\n\r\nOptional. Today as default",
"format": "date-time",
"nullable": true
},
"ItemsAmountCalculateType": {
"allOf": [
{
"$ref": "#/components/schemas/APIItemsAmountCalculateType"
}
],
"description": "Which prices should be taken to calculation net or gross\r\n\r\n0 - [FromNet] - Net values are primary\r\n1 - [FromGross] - Gross values are primary\r\n\r\nDefault: Net\n\n0 = FromNet\n\n1 = FromGross",
"nullable": true
},
"Notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes (visible on invoice)",
"nullable": true
},
"MadeOutBy": {
"maxLength": 200,
"type": "string",
"description": "Person who made out this invoice (printed)\r\n\r\nOptional. Default empty",
"nullable": true
},
"ReceivedBy": {
"maxLength": 200,
"type": "string",
"description": "Person who recieved this invoice\r\n\r\nOptional. Default empty.",
"nullable": true
},
"OrderNumber": {
"maxLength": 100,
"type": "string",
"description": "Order number\r\n\r\nOptional. Default empty.",
"nullable": true
},
"ContractNumber": {
"maxLength": 100,
"type": "string",
"description": "Contract number\r\n\r\nOptional. Default empty.",
"nullable": true
},
"VATExemptionType": {
"allOf": [
{
"$ref": "#/components/schemas/APIVATExemptionType"
}
],
"description": "Specifies the legal basis for VAT exemption.\r\n\r\n0 - [NotApplicable] - VAT exemption does not apply (default value)\r\n1 - VatAct - VAT exemption based on the national VAT Act\r\n2 - EUDirectives - VAT exemption based on applicable EU Directives\r\n3 - OtherLegalBasis - VAT exemption based on another legal basis\r\n\r\nDefault = NotApplicable\n\n0 = NotApplicable\n\n1 = VATAct\n\n2 = EUDirectives\n\n3 = OtherLegalBasis",
"nullable": true
},
"VATExemptionDetails": {
"maxLength": 200,
"type": "string",
"description": "Provides detailed legal reference for the applied VAT exemption.",
"nullable": true
},
"MarginAdditionalType": {
"allOf": [
{
"$ref": "#/components/schemas/APIMarginAdditionalType"
}
],
"description": "Specifies the detailed type under the VAT margin scheme (MR_UZ procedure).\r\n\r\n0 - NotApplicable - Margin procedure does not apply\r\n1 - UsedGoods - Used goods\r\n2 - WorksOfArt - Works of art\r\n3 - CollectorsItemsAndAntiques - Collectors' items and antiques\r\n\r\nDefault = NotApplicable\n\n0 = NotApplicable\n\n1 = UsedGoods\n\n2 = WorksOfArt\n\n3 = CollectorsItemsAndAntiques",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"InvoiceProductEditModeEnum": {
"enum": [
1,
2,
3
],
"type": "integer",
"description": "What to do with product that was edit on invoice\n\n1 = Ask\n\n2 = AlwaysUpdate\n\n3 = DoNotUpdate",
"format": "int32",
"x-enumNames": [
"Ask",
"AlwaysUpdate",
"DoNotUpdate"
]
},
"InvoiceSummary": {
"type": "object",
"properties": {
"TotalNet": {
"type": "number",
"description": "Total Net",
"format": "double",
"nullable": true
},
"TotalTax": {
"type": "number",
"description": "Total VAT",
"format": "double",
"nullable": true
},
"TotalGross": {
"type": "number",
"description": "Total Gross",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice summary section"
},
"KSeFDetails": {
"type": "object",
"properties": {
"KSeFNumber": {
"type": "string",
"description": "KSEF number",
"nullable": true
},
"KSeFDate": {
"type": "string",
"description": "KSeF Acceptance Date",
"format": "date-time",
"nullable": true
},
"KSeFDrawnUpDate": {
"type": "string",
"description": "Issue Date (in the KSeF document)",
"format": "date-time",
"nullable": true
},
"KSeFVerificationURL": {
"type": "string",
"description": "KSeF Verification url",
"nullable": true
},
"KSeFCertificateURL": {
"type": "string",
"description": "KSeF certificate url (for offline invoices)",
"nullable": true
},
"SendToKSeFMode": {
"allOf": [
{
"$ref": "#/components/schemas/APISendToKsefMode"
}
],
"description": "Determines whether the document should be sent to the KSeF system:\r\n\r\n0 / null - Automatic (based on customer and buyer settings)\r\n1 - Always send to KSeF\r\n-1 - Never send to KSeF\n\n0 = Auto\n\n1 = Send\n\n-1 = DontSend",
"nullable": true
}
},
"additionalProperties": false,
"description": "KSEF details - read only"
},
"KSeFDetailsBase": {
"type": "object",
"properties": {
"SendToKSeFMode": {
"allOf": [
{
"$ref": "#/components/schemas/APISendToKsefMode"
}
],
"description": "Determines whether the document should be sent to the KSeF system:\r\n\r\n0 / null - Automatic (based on customer and buyer settings)\r\n1 - Always send to KSeF\r\n-1 - Never send to KSeF\n\n0 = Auto\n\n1 = Send\n\n-1 = DontSend",
"nullable": true
}
},
"additionalProperties": false,
"description": "Base class for KSeF details used for POST endpoints"
},
"LimitationInfo": {
"type": "object",
"properties": {
"IDInternal": {
"type": "integer",
"description": "ID wewnetrzne",
"format": "int32"
},
"CustomerServiceLevel": {
"type": "integer",
"description": "Poziomu uslug wartosci jak (CustomerServiceLevelEnum)",
"format": "int32",
"nullable": true
},
"AccountingOfficeServiceLevel": {
"type": "integer",
"description": "Poziomu uslug biura wartosci jak (CustomerServiceLevelEnum)",
"format": "int32",
"nullable": true
},
"LimitKey": {
"maxLength": 100,
"type": "string",
"description": "Klucz limitu do jakiego odnosi sie wpis (na podstawie Meta_Customers_Custom_Limits)",
"nullable": true
},
"MaxUsageLimit": {
"type": "integer",
"description": "Maksymalne mozliwe zuzycie na poziomie",
"format": "int32",
"nullable": true
},
"NearLimitMessage": {
"maxLength": 500,
"type": "string",
"description": "Tresc wiadomosci gdy zbliza sie do limitu",
"nullable": true
},
"NearLimitThresholdPercent": {
"type": "number",
"description": "Przy ilu procentach maksymalnego limitu ma sie pokazywac wiadomosc o zblizaniu sie do limitu",
"format": "double",
"nullable": true
},
"LimitReachedOrExceededMessage": {
"maxLength": 500,
"type": "string",
"description": "Tresc wiadomosci przy osiagniecu lub przekroczeniu limitu",
"nullable": true
},
"HideMessageOnLimitReached": {
"type": "boolean",
"description": "Czy ukryc wiadomosc przy osiagnieciu limitu",
"nullable": true
},
"IDCallToActionPopup": {
"type": "integer",
"description": "ID popupu call 2 action jaki ma sie odpalic",
"format": "int32",
"nullable": true
},
"IDOrderProcess": {
"type": "integer",
"description": "ID procesu zamowienia jaki ma sie odpalic",
"format": "int32",
"nullable": true
},
"IDOrderProcessService": {
"type": "integer",
"description": "Jaka ma byc wyjsciowa usluga w przypadku zamowienia",
"format": "int32",
"nullable": true
},
"BlockServiceOnLimitReachedOrExceeded": {
"type": "boolean",
"description": "Czy zamowienie uslugi ma byc blokowane przy przekroczeniu limitu",
"nullable": true
},
"EntityID": {
"type": "integer",
"description": "Uniwersalne ID obiektu",
"format": "int32",
"readOnly": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/LimitationStatusEnum"
}
],
"description": "Status usługi\n\n0 = Unlimited\n\n1 = NormalUsage\n\n2 = NearLimit\n\n3 = LimitReached\n\n4 = LimitExceeded",
"readOnly": true,
"x-enumNames": [
"Unlimited",
"NormalUsage",
"NearLimit",
"LimitReached",
"LimitExceeded"
]
},
"IsBlocked": {
"type": "boolean",
"description": "Czy usluga jest zablokowana - np. nie mozna dodawac faktury itp.",
"readOnly": true
},
"CurrentUsage": {
"type": "integer",
"description": "ilosc aktualnie uzytych w ramach limitu",
"format": "int32"
},
"AdditionalMaxUsageLimitForMessage": {
"type": "integer",
"description": "Dodatkowa wartosc dodawana do limitu - uzywana wylaczenie wiadomosci",
"format": "int32",
"nullable": true
},
"ShowNearLimitMessage": {
"type": "boolean",
"description": "Pokaz komunikat o zblizaniu sie do limitow",
"readOnly": true
},
"NearLimitThreshold": {
"type": "integer",
"description": "kiedy pokazujemy warning ze zbliszasz sie do limitu",
"format": "int32",
"nullable": true,
"readOnly": true
},
"ShowMaxUsageLimitMessage": {
"type": "boolean",
"description": "Pokaz komunikat o przekroczeniu limitow",
"readOnly": true
},
"LeftToUse": {
"type": "integer",
"description": "Ile jeszcze pozostalo do zuzycia w ramach limitu\r\njak bez limitu to -1",
"format": "int32",
"readOnly": true
},
"IsNormalUsage": {
"type": "boolean",
"description": "Czy normalne zuzycie limitu",
"readOnly": true
},
"IsNearLimit": {
"type": "boolean",
"description": "Czy blisko do przekroczenia limitu",
"readOnly": true
},
"IsLimitReached": {
"type": "boolean",
"description": "Czy limit zostal osiagniety",
"readOnly": true
},
"IsLimitExceeded": {
"type": "boolean",
"description": "Czy limit zostal przekroczony",
"readOnly": true
},
"IsUnlimited": {
"type": "boolean",
"description": "Czy bez limitu",
"readOnly": true
},
"IsLimitReachedOrExceeded": {
"type": "boolean",
"description": "Czy limit zostal osiagniety lub przekroczony",
"readOnly": true
},
"IsCustomLimit": {
"type": "boolean",
"description": "Czy limit ustawiony z custom"
},
"ActivateAccServiceForCustomer": {
"type": "boolean",
"description": "Czy aktywowac usluge na kliencie z pakietu biura"
},
"ShowUsageStatusAction": {
"type": "boolean",
"description": "Czy pokazac akcjess",
"readOnly": true
},
"___IsFromDB": {
"type": "boolean",
"description": "Ustawiane podczas odczytu obiektu z bazy danych - jezeli obiekt pochodzi z serializacji z UI powinien miec false\r\nDzieki temu jezeli potrzebujemy historyczny obiekt wiemy czy musimy go pobierac z bazy (jezeli =true) czy wystarczy z cache(=false)"
}
},
"additionalProperties": false,
"description": " Obiekt biznesowy bazujący na Meta_Config_Limitations {tabela}\r\n\r\n Opis źródla danych:\r\n (brak)\r\n\r\n Modyfikacje:\r\n\t\t- wygenerowano AUTOMATYCZNIE [SQL v.1.26]"
},
"LimitationStatusEnum": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "Opis: \r\n okresla status informacji o usludze i jej stanie przekroczenia limitow\n\n0 = Unlimited\n\n1 = NormalUsage\n\n2 = NearLimit\n\n3 = LimitReached\n\n4 = LimitExceeded",
"format": "int32",
"x-enumNames": [
"Unlimited",
"NormalUsage",
"NearLimit",
"LimitReached",
"LimitExceeded"
]
},
"LoginInputModel": {
"type": "object",
"properties": {
"Login": {
"type": "string",
"description": "Login",
"nullable": true
},
"Password": {
"type": "string",
"description": "Hasło",
"nullable": true
},
"TokenLabel": {
"type": "string",
"description": "Nazwa sesji (mobilka/desktop/etc)",
"nullable": true
}
},
"additionalProperties": false,
"description": "input model do nowego logowania do api"
},
"LoginMFAInputModel": {
"required": [
"ChannelType"
],
"type": "object",
"properties": {
"ChannelType": {
"type": "integer",
"description": "kanał",
"format": "int32"
},
"VerificationData": {
"type": "string",
"description": "kod weryfikacyjny",
"nullable": true
}
},
"additionalProperties": false,
"description": "Logowanie MFA do api"
},
"LoginResponse": {
"type": "object",
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/LoginStatusEnum"
}
],
"description": "Status\n\n0 = Success\n\n1 = MfaRequired\n\n2 = SsoRequired",
"x-enumNames": [
"Success",
"MfaRequired",
"SsoRequired"
]
},
"AccessToken": {
"type": "string",
"description": "token dostępu (jeśli dotyczy)",
"nullable": true
},
"RefreshToken": {
"type": "string",
"description": "token odświeżenia (jeśli dotyczy)",
"nullable": true
},
"MfaAvailableChannels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MFAChannelTypeEnum"
},
"description": "kanały mfa użytkownika (pierwszy jest domyślny)",
"nullable": true
},
"MfaTempToken": {
"type": "string",
"description": "Tymczasowy token MFA",
"nullable": true
},
"MfaBrowserLoginUrl": {
"type": "string",
"description": "URL do weryfikacji MFA w przeglądarce, jeśli aplikacja nie obsługuje danego kanału",
"nullable": true
},
"SsoBrowserLoginUrl": {
"type": "string",
"description": "URL do odpalenia SSO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Wynik logowania do API"
},
"LoginResponseAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"allOf": [
{
"$ref": "#/components/schemas/LoginResponse"
}
],
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"LoginStatusEnum": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "Status logowania do api\n\n0 = Success\n\n1 = MfaRequired\n\n2 = SsoRequired",
"format": "int32",
"x-enumNames": [
"Success",
"MfaRequired",
"SsoRequired"
]
},
"MFAChannelTypeEnum": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "Typy kanałów MFA\n\n0 = SMS\n\n1 = TOTP\n\n2 = Fido2\n\n3 = BackupCode\n\n4 = MobileApp\n\n5 = Dev\n\n6 = PlatformManagement",
"format": "int32",
"x-enumNames": [
"SMS",
"TOTP",
"Fido2",
"BackupCode",
"MobileApp",
"Dev",
"PlatformManagement"
]
},
"ManualExecutionProcessInfo": {
"type": "object",
"properties": {
"ProcessName": {
"type": "string",
"description": "Nazwa procesu",
"nullable": true
},
"WindowTitle": {
"type": "string",
"description": "Tytuł okna",
"nullable": true
},
"WindowClassName": {
"type": "string",
"description": "Nazwa klasy okna",
"nullable": true
},
"WindowXML": {
"type": "string",
"description": "Zawartość okna w XML",
"nullable": true
}
},
"additionalProperties": false,
"description": "Klasa proxy dla danych wykonania recznego akcji SmartAction pozwalajacymi utworzyc akcję automatyczną."
},
"ObjectAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"ParentDetails": {
"type": "object",
"properties": {
"IDParentInvoice": {
"type": "integer",
"description": "ID parent invoice",
"format": "int32",
"nullable": true
},
"ParentDocumentNumber": {
"type": "string",
"description": "Parent document number",
"nullable": true
},
"ParentMadeOutDate": {
"type": "string",
"description": "Parent made out date",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Parent section"
},
"PaymentDetails": {
"type": "object",
"properties": {
"PaymentForm": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentForm"
}
],
"description": "Payment form:\r\n\r\n1 - [Cash] - Cash\r\n2 - [BankTransfer] - Bank transfer\r\n3 - [CreditCard] - Credit card\r\n4 - [PaymentCard] - Payment card\r\n5 - [Custom] - Custom\r\n6 - [CashPaid] - Paid by cash\r\n7 - [BankTransferPaid] - Paid by bank transfer\r\n8 - [Compensation] - Compensation\r\n9 - [PaidByElectronicPayment] - Paid by electronic payment\r\n10 - [Barter] - Barter\r\n11 - [PaidByPayPal] - PayPal\r\n12 - [BankTransferOrElectronicPayment] - Bank transfer or electronic payment\r\n13 - [ElectronicPayment] - Electronic payment\r\n14 - [CashOnDelivery] - Cash on delivery\r\n15 - [PaidByStripe] - Stripe\r\n16 - [PaidByAmazon] - Amazon\r\n17 - [PaidByAllegro] - Allegro\r\n18 - [PaidByEtsy] - Etsy\r\n19 - [PaidByArena] - Arena\r\n20 - [TuristVoucher] - Turist voucher\r\n21 - [PaidByTPay] - Paid by TPay\r\n22 - [PaidByPayU] - Paid by PayU\r\n23 - [PaidByPrzelewy24] - Paid by Przelewy24\r\n24 - [Installments] - Installments\r\n25 - [Voucher] - Voucher\r\n26 - [Check] - Check\r\n27 - [PaidByMontonio] - Montonio\n\n1 = Cash\n\n2 = BankTransfer\n\n3 = CreditCard\n\n4 = PaymentCard\n\n5 = Custom\n\n6 = CashPaid\n\n7 = BankTransferPaid\n\n8 = Compensation\n\n9 = PaidByElectronicPayment\n\n10 = Barter\n\n11 = PaidByPayPal\n\n12 = BankTransferOrElectronicPayment\n\n13 = ElectronicPayment\n\n14 = CashOnDelivery\n\n15 = PaidByStripe\n\n16 = PaidByAmazon\n\n17 = PaidByAllegro\n\n18 = PaidByEtsy\n\n19 = PaidByArena\n\n20 = TuristVoucher\n\n21 = PaidByTPay\n\n22 = PaidByPayU\n\n23 = PaidByPrzelewy24\n\n24 = Installments\n\n25 = Voucher\n\n26 = Check\n\n27 = PaidByMontonio",
"nullable": true
},
"BankAccount": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountDetails"
}
],
"description": "Bank account",
"nullable": true
},
"PaymentDeadline": {
"type": "string",
"description": "Due date",
"format": "date-time",
"nullable": true
},
"PaymentEventType": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentEventType"
}
],
"description": "The event triggering the payment of the invoice:\r\n\r\n0 - [DrawnUpDate] - Draw up date\r\n1 - [DeliveryDate] - Delivery date\r\n2 - [CollectionDate] - Collection date\r\n3 - [CollectionOfDocumentDate] - Collection of document date\n\n0 = DrawnUpDate\n\n1 = DeliveryDate\n\n2 = CollectionDate\n\n3 = CollectionOfDocumentDate",
"nullable": true
},
"PaymentEventDays": {
"type": "integer",
"description": "Days from the event triggering the payment of the invoice",
"format": "int32",
"nullable": true
},
"PaymentEventDate": {
"type": "string",
"description": "Date of the event triggering the payment of the invoice",
"format": "date-time",
"nullable": true
},
"PaidAmount": {
"type": "number",
"description": "Paid amount (printed on invoice)",
"format": "double",
"nullable": true
},
"PaidAmountDate": {
"type": "string",
"description": "Paid amount date (printed on invoice)",
"format": "date-time",
"nullable": true
},
"PaidAmountPaymentForm": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentForm"
}
],
"description": "Paid amount payment form:\r\n\r\n1 - [Cash] - Cash\r\n2 - [BankTransfer] - Bank transfer\r\n3 - [CreditCard] - Credit card\r\n4 - [PaymentCard] - Payment card\r\n5 - [Custom] - Custom\r\n6 - [CashPaid] - Paid by cash\r\n7 - [BankTransferPaid] - Paid by bank transfer\r\n8 - [Compensation] - Compensation\r\n9 - [PaidByElectronicPayment] - Paid by electronic payment\r\n10 - [Barter] - Barter\r\n11 - [PaidByPayPal] - PayPal\r\n12 - [BankTransferOrElectronicPayment] - Bank transfer or electronic payment\r\n13 - [ElectronicPayment] - Electronic payment\r\n14 - [CashOnDelivery] - Cash on delivery\r\n15 - [PaidByStripe] - Stripe\r\n16 - [PaidByAmazon] - Amazon\r\n17 - [PaidByAllegro] - Allegro\r\n18 - [PaidByEtsy] - Etsy\r\n19 - [PaidByArena] - Arena\r\n20 - [TuristVoucher] - Turist voucher\r\n21 - [PaidByTPay] - Paid by TPay\r\n22 - [PaidByPayU] - Paid by PayU\r\n23 - [PaidByPrzelewy24] - Paid by Przelewy24\r\n24 - [Installments] - Installments\r\n25 - [Voucher] - Voucher\r\n26 - [Check] - Check\r\n27 - [PaidByMontonio] - Montonio\n\n1 = Cash\n\n2 = BankTransfer\n\n3 = CreditCard\n\n4 = PaymentCard\n\n5 = Custom\n\n6 = CashPaid\n\n7 = BankTransferPaid\n\n8 = Compensation\n\n9 = PaidByElectronicPayment\n\n10 = Barter\n\n11 = PaidByPayPal\n\n12 = BankTransferOrElectronicPayment\n\n13 = ElectronicPayment\n\n14 = CashOnDelivery\n\n15 = PaidByStripe\n\n16 = PaidByAmazon\n\n17 = PaidByAllegro\n\n18 = PaidByEtsy\n\n19 = PaidByArena\n\n20 = TuristVoucher\n\n21 = PaidByTPay\n\n22 = PaidByPayU\n\n23 = PaidByPrzelewy24\n\n24 = Installments\n\n25 = Voucher\n\n26 = Check\n\n27 = PaidByMontonio",
"nullable": true
},
"PaidAmountForNow": {
"type": "number",
"description": "Current paid amount (not printed - for payment processing)",
"format": "double",
"nullable": true
},
"LastSettlementDate": {
"type": "string",
"description": "If the invoice is paid in full, it is the date on which it was finally paid",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payment section"
},
"PaymentDetailsSeries": {
"type": "object",
"properties": {
"Currency": {
"maxLength": 50,
"type": "string",
"description": "Currency code (ISO) i.e. USD, EUR, GBP, PLN",
"nullable": true
},
"PaymentForm": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentForm"
}
],
"description": "Payment form:\r\n\r\n1 - [Cash] - Cach\r\n2 - [BankTransfer] - Bank transfer\r\n3 - [CreditCard] - Credit card\r\n4 - [PaymentCard] - Payment card\r\n5 - [Custom] - Custom\r\n6 - [CashPaid] - Paid by cash\r\n7 - [BankTransferPaid] - Paid by bank transfer\r\n8 - [Compensation] - Compensation\r\n9 - [PaidByElectronicPayment] - Paid by electronic payment\r\n10 - [Barter] - Barter\r\n11 - [PaidByPayPal] - PayPal\r\n12 - [BankTransferOrElectronicPayment] - Bank transfer or electronic payment\r\n13 - [ElectronicPayment] - Electronic payment\r\n14 - [CashOnDelivery] - Cash on delivery\r\n15 - [PaidByStripe] - Stripe\r\n16 - [PaidByAmazon] - Amazon\r\n17 - [PaidByAllegro] - Allegro\r\n18 - [PaidByEtsy] - Etsy\r\n19 - [PaidByArena] - Arena\r\n20 - [TuristVoucher] - Turist voucher\r\n21 - [PaidByTPay] - Paid by TPay\r\n22 - [PaidByPayU] - Paid by PayU\r\n23 - [PaidByPrzelewy24] - Paid by Przelewy24\r\n24 - [Installments] - Installments\r\n25 - [Voucher] - Voucher\r\n26 - [Check] - Check\r\n27 - [PaidByMontonio] - Montonio\n\n1 = Cash\n\n2 = BankTransfer\n\n3 = CreditCard\n\n4 = PaymentCard\n\n5 = Custom\n\n6 = CashPaid\n\n7 = BankTransferPaid\n\n8 = Compensation\n\n9 = PaidByElectronicPayment\n\n10 = Barter\n\n11 = PaidByPayPal\n\n12 = BankTransferOrElectronicPayment\n\n13 = ElectronicPayment\n\n14 = CashOnDelivery\n\n15 = PaidByStripe\n\n16 = PaidByAmazon\n\n17 = PaidByAllegro\n\n18 = PaidByEtsy\n\n19 = PaidByArena\n\n20 = TuristVoucher\n\n21 = PaidByTPay\n\n22 = PaidByPayU\n\n23 = PaidByPrzelewy24\n\n24 = Installments\n\n25 = Voucher\n\n26 = Check\n\n27 = PaidByMontonio",
"nullable": true
},
"BankAccountNumber": {
"type": "string",
"description": "Bank account number",
"nullable": true
},
"PaymentEventDays": {
"type": "integer",
"description": "Days from the event triggering the payment of the invoice",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payment section"
},
"PaymentDetailsSourceInvoice": {
"type": "object",
"properties": {
"PaymentForm": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentForm"
}
],
"description": "Payment form:\r\n\r\n1 - [Cash] - Cach\r\n2 - [BankTransfer] - Bank transfer\r\n3 - [CreditCard] - Credit card\r\n4 - [PaymentCard] - Payment card\r\n5 - [Custom] - Custom\r\n6 - [CashPaid] - Paid by cash\r\n7 - [BankTransferPaid] - Paid by bank transfer\r\n8 - [Compensation] - Compensation\r\n9 - [PaidByElectronicPayment] - Paid by electronic payment\r\n10 - [Barter] - Barter\r\n11 - [PaidByPayPal] - PayPal\r\n12 - [BankTransferOrElectronicPayment] - Bank transfer or electronic payment\r\n13 - [ElectronicPayment] - Electronic payment\r\n14 - [CashOnDelivery] - Cash on delivery\r\n15 - [PaidByStripe] - Stripe\r\n16 - [PaidByAmazon] - Amazon\r\n17 - [PaidByAllegro] - Allegro\r\n18 - [PaidByEtsy] - Etsy\r\n19 - [PaidByArena] - Arena\r\n20 - [TuristVoucher] - Turist voucher\r\n21 - [PaidByTPay] - Paid by TPay\r\n22 - [PaidByPayU] - Paid by PayU\r\n23 - [PaidByPrzelewy24] - Paid by Przelewy24\r\n24 - [Installments] - Installments\r\n25 - [Voucher] - Voucher\r\n26 - [Check] - Check\r\n27 - [PaidByMontonio] - Montonio\n\n1 = Cash\n\n2 = BankTransfer\n\n3 = CreditCard\n\n4 = PaymentCard\n\n5 = Custom\n\n6 = CashPaid\n\n7 = BankTransferPaid\n\n8 = Compensation\n\n9 = PaidByElectronicPayment\n\n10 = Barter\n\n11 = PaidByPayPal\n\n12 = BankTransferOrElectronicPayment\n\n13 = ElectronicPayment\n\n14 = CashOnDelivery\n\n15 = PaidByStripe\n\n16 = PaidByAmazon\n\n17 = PaidByAllegro\n\n18 = PaidByEtsy\n\n19 = PaidByArena\n\n20 = TuristVoucher\n\n21 = PaidByTPay\n\n22 = PaidByPayU\n\n23 = PaidByPrzelewy24\n\n24 = Installments\n\n25 = Voucher\n\n26 = Check\n\n27 = PaidByMontonio",
"nullable": true
},
"BankAccount": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountDetails"
}
],
"description": "Bank account",
"nullable": true
},
"PaymentEventType": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentEventType"
}
],
"description": "The event triggering the payment of the invoice:\r\n\r\n0 - [DrawnUpDate] - Draw up date\r\n1 - [DeliveryDate] - Delivery date\r\n2 - [CollectionDate] - Collection date\r\n3 - [CollectionOfDocumentDate] - Collection of document date\n\n0 = DrawnUpDate\n\n1 = DeliveryDate\n\n2 = CollectionDate\n\n3 = CollectionOfDocumentDate",
"nullable": true
},
"PaymentEventDays": {
"type": "integer",
"description": "Days from the event triggering the payment of the invoice",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payment section"
},
"PrintSettings": {
"type": "object",
"properties": {
"PrintAccountNumber": {
"type": "boolean",
"description": "Show Issuer Bank Account number (default: true)"
},
"PrintBankName": {
"type": "boolean",
"description": "Show Issuer Bank Account name (default: true)"
},
"PrintEmail": {
"type": "boolean",
"description": "Show Issuer EMAIL adress (default: true)"
},
"PrintMobilePhoneNo": {
"type": "boolean",
"description": "Show Issuer MOBILE PHONE number (default: true)"
},
"PrintPhoneNo": {
"type": "boolean",
"description": "Show Issuer PHONE number (default: true)"
},
"PrintSwift": {
"type": "boolean",
"description": "Show Issuer Bank Account SWIFT (default: true)"
},
"PrintyWebsite": {
"type": "boolean",
"description": "Show Issuer WWW (default: true)"
},
"PrintCurrencyConversionRate": {
"type": "boolean",
"description": "Show currency conversion rate (default: true)"
},
"PrintMadeOutSignature": {
"type": "boolean",
"description": "Show \"made out\" signature placeholder (in the footer for KSeF invoices) (default: true)"
},
"PrintReceivedBySignature": {
"type": "boolean",
"description": "Show \"recieved by\" signature placeholder (in the recipient section for KSeF invoices) (default: true)"
},
"PrintDiscountIfItIsZero": {
"type": "boolean",
"description": "Show discount column when all discount equals zero (not applicable to KSeF) (default: false)"
},
"PrintBaseCurrencySummaryForCurrencyDocument": {
"type": "boolean",
"description": "Show summary in issuer currency when different then invoice currency (not applicable to KSeF) (default: false)"
},
"PrintVATID": {
"type": "boolean",
"description": "Show VAT ID (default: true)"
},
"PrintRegon": {
"type": "boolean",
"description": "Show Regon (default: false)"
},
"PrintAdditionalVATID": {
"type": "boolean",
"description": "Show additional VAT ID (default: false)\r\nNot applicable in Poland"
},
"PrintCustomVATIDLabel": {
"type": "boolean",
"description": "Show custom VAT ID label (default: false)"
},
"PrintOnlyChangedCorectedItems": {
"type": "boolean",
"description": "If true - only changed positions will be printed on correction (default: false)"
},
"PrintPackagingDatabaseNo": {
"type": "boolean",
"description": "Show Issuer packaging database number (default: false)"
},
"PrintProductVATCode": {
"type": "boolean",
"description": "Show Product VAT Code (default: false)"
},
"PrintItemsLineDescription": {
"type": "boolean",
"description": "Show line description of item (default: false)"
},
"PrintOrderNumber": {
"type": "boolean",
"description": "Show order number (default: false)"
},
"PrintContractNumber": {
"type": "boolean",
"description": "Show contract number (default: false)"
},
"PrintVATProcedures": {
"type": "boolean",
"description": "Show VAT procedures (not applicable to KSeF) (default: false)"
},
"PrintUnpaidInvoicesForContractor": {
"type": "boolean",
"description": "Show table with unpaid invoices for contractor (default: false)"
},
"PrintNotesFullWidth": {
"type": "boolean",
"description": "Show notes full width of page (not applicable to KSeF) (default: false)"
},
"PrintPaymentDetailsAboveSeller": {
"type": "boolean",
"description": "Show payment details above the seller data (not applicable to KSeF) (default: false)"
},
"PrintPaymentForTwoCurrencyTypeInKSeFInvoiceFooter": {
"type": "boolean",
"description": "Show payment additional information in invoice footer (KSeF) (default: true)"
},
"PrintBuyerEmail": {
"type": "boolean",
"description": "Display buyer email - send it to KSeF (default: true)"
},
"PrintPaymentDetailsInKSeFAlways": {
"type": "boolean",
"description": "Always display the payment sections on the KSeF invoice (including for corrections with a value of 0) (default: false)"
},
"PrintCurrencyConversionDetailsInKSeF": {
"type": "boolean",
"description": "Display in Additional desctiption in KSeF invoice currency exchange rate, date and exchange rate source table informations (default: false)"
}
},
"additionalProperties": false,
"description": "Show/hide Issuer information on printed invoice (PDF)"
},
"ReceiverDetails": {
"type": "object",
"properties": {
"ReceiverName": {
"maxLength": 200,
"type": "string",
"description": "Receiver Bane",
"nullable": true
},
"ReceiverId": {
"type": "integer",
"description": "Receiver ID (optional)",
"format": "int32",
"nullable": true
},
"ContractorReceiverType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorReceiverType"
}
],
"description": "Receiver type \r\n\r\n0 - Standard\r\n1 - JST\r\n2 - VAT Group\r\n3 - Other role\r\n\r\nDefault: Standard\n\n0 = Standard\n\n1 = JST\n\n2 = VatGroup\n\n3 = RoleOther",
"nullable": true
},
"ReceiverIdentifierType": {
"allOf": [
{
"$ref": "#/components/schemas/APIContractorIndentifierType"
}
],
"description": "Receiver identifier type \r\n\r\n0/null - [REGON] - REGON\r\n1 - [TaxID] - TaxID i.e. NIP\r\n2 - [PersonalID] - PersonalID i.e. PESEL\r\n3 - [Other] - Other identifier\r\n4 - [InternalID] - internal ID (f.ex. KSeF internal number)\r\n\r\nDefault: REGON\n\n0 = REGON\n\n1 = TaxID\n\n2 = PersonalID\n\n3 = Other\n\n4 = InternalID\n\n10 = NoIdentificationMethod",
"nullable": true
},
"ReceiverAddressStreet": {
"maxLength": 200,
"type": "string",
"description": "Street",
"nullable": true
},
"ReceiverAddressCity": {
"maxLength": 200,
"type": "string",
"description": "City and postal code",
"nullable": true
},
"ReceiverAddressCountry": {
"maxLength": 200,
"type": "string",
"description": "Country",
"nullable": true
},
"ReceiverCountryCode": {
"maxLength": 20,
"type": "string",
"description": "Country code",
"nullable": true
},
"ReceiverExternalID": {
"maxLength": 50,
"type": "string",
"description": "External ID (optional) i.e. REGON",
"nullable": true
}
},
"additionalProperties": false,
"description": "Receiver section\r\n\r\nOptional. Only if receiver is different then Buyer"
},
"RefreshTokenInputModel": {
"required": [
"RefreshToken"
],
"type": "object",
"properties": {
"RefreshToken": {
"minLength": 1,
"type": "string",
"description": "token do odświeżenia sesji"
}
},
"additionalProperties": false,
"description": "Input model odświeżania sesji API"
},
"RefreshTokenWithPINInputModel": {
"required": [
"DeviceID",
"RefreshToken",
"UserLogin",
"UserPIN"
],
"type": "object",
"properties": {
"RefreshToken": {
"minLength": 1,
"type": "string",
"description": "token do odświeżenia sesji"
},
"UserLogin": {
"minLength": 1,
"type": "string",
"description": "Login wczesniej zalgoowanego usera - konieczny do sprawdzenia PIN"
},
"DeviceID": {
"minLength": 1,
"type": "string",
"description": "DeviceID, ktorym user chce sie zalogowac - konieczny do sprawdzenia PIN"
},
"UserPIN": {
"minLength": 1,
"type": "string",
"description": "PIN powiazany ze zglaszanym urzadzeniem (wpisywany przez Usera lub pobierany z biometrii)"
}
},
"additionalProperties": false,
"description": "Input model odświeżania sesji API dla mobilek zabezpieczonych PINem / biometria -> tylko do przegenerowania tokena po wlaczeniu aplikacji"
},
"RegistrationInfo": {
"type": "object",
"properties": {
"RegisteredByUserId": {
"type": "integer",
"description": "User ID who registered",
"format": "int32",
"nullable": true
},
"RegisteredByUserLogin": {
"type": "string",
"description": "Registered by login",
"nullable": true
},
"RegistrationDate": {
"type": "string",
"description": "Date of registration",
"format": "date-time",
"nullable": true
},
"RegistrationComment": {
"type": "string",
"description": "Registration comment",
"nullable": true
}
},
"additionalProperties": false,
"description": "Registration info"
},
"RejectionInfo": {
"type": "object",
"properties": {
"RejectedByUserId": {
"type": "integer",
"description": "Rejected by user ID",
"format": "int32",
"nullable": true
},
"RejectedByUserLogin": {
"type": "string",
"description": "Rejected by login",
"nullable": true
},
"RejectionDate": {
"type": "string",
"description": "Date of rejection",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Rejection info"
},
"RestartMFAInputModel": {
"required": [
"ChannelType"
],
"type": "object",
"properties": {
"ChannelType": {
"type": "integer",
"description": "kanał",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Rozpocznij (ponownie) flow mfa"
},
"SendByEmailParams": {
"required": [
"Email"
],
"type": "object",
"properties": {
"Email": {
"minLength": 1,
"type": "string",
"description": "Email adress"
},
"Message": {
"type": "string",
"description": "Optional message included in email",
"nullable": true
},
"Language": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Send email in specific language (optional):\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
},
"DuplicateDate": {
"type": "string",
"description": "Usual empty - if not, there will be generated duplicate of an invoice with specific date",
"format": "date-time",
"nullable": true
},
"AddPDFToEmail": {
"type": "boolean",
"description": "Attach PDF file with invoice to e-mail (optional - if null checks the invoice series settings)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Send by email command parameters"
},
"SendBySMSParams": {
"required": [
"PhoneNumber"
],
"type": "object",
"properties": {
"PhoneNumber": {
"minLength": 1,
"type": "string",
"description": "Phone number"
},
"Language": {
"allOf": [
{
"$ref": "#/components/schemas/APILanguageCode"
}
],
"description": "Send SMS in specific language (optional):\r\n\r\n0 - [PL] - Polish\r\n1 - [EN] - English\r\n2 - [DE] - Germany\r\n3 - [RU] - Russian\r\n4 - [CS] - Czech\r\n5 - [FR] - French\r\n6 - [IT] - Italy\r\n7 - [ES] - Spain\r\n8 - [UK] - Ukrainian\r\n9 - [SV] - Swedish\r\n10 - [DA] - Danish\r\n11 - [FI] - Finnish\r\n12 - [NB] - Norwegian\n\n0 = PL\n\n1 = EN\n\n2 = DE\n\n3 = RU\n\n4 = CS\n\n5 = FR\n\n6 = IT\n\n7 = ES\n\n8 = UK\n\n9 = SV\n\n10 = DA\n\n11 = FI\n\n12 = NB\n\n-1 = None",
"nullable": true
}
},
"additionalProperties": false,
"description": "Send by email command parameters"
},
"SmartActionRule": {
"type": "object",
"properties": {
"IDSmartActionRule": {
"type": "integer",
"description": "Identyfikator reguły",
"format": "int32"
},
"IsEnabled": {
"type": "boolean",
"description": "Czy reguła jest aktywna"
},
"IDSmartAction": {
"type": "integer",
"description": "Akcja wykonywana przy spelnieniu reguly: 1-wyszukiwanie faktury;2-zmiana klienta (nazwa);3-zmiana klienta(nip)",
"format": "int32",
"nullable": true
},
"Filter_ProcessName": {
"maxLength": 500,
"type": "string",
"description": "Filtr reguły - element nazwy aktywnego procesu",
"nullable": true
},
"Filter_WindowTitle": {
"maxLength": 500,
"type": "string",
"description": "Filtr reguły - tytuł okna aktywnej aplikacji (może być wiele - rozdzielone przecinkami)",
"nullable": true
},
"Filter_WindowClassName": {
"maxLength": 500,
"type": "string",
"description": "Filtr reguły - klasa programistyczna aktywnego okna",
"nullable": true
},
"ActionValue_XPath": {
"type": "string",
"description": "Sposób wydobycia wartości z XML okna za pomoća Xpath",
"nullable": true
},
"ActionValue_RegEx": {
"maxLength": 1000,
"type": "string",
"description": "Opcjonalnie: sposób wydobycia wartości wyrażeniem regularnym z efektu działania XPath",
"nullable": true
},
"IDERPSystem": {
"type": "integer",
"description": "opcjonalnie - jakiego systemu erp dotyczy regula; NULL - nie filtruj po systemach klienta/biura",
"format": "int32",
"nullable": true
},
"Order": {
"type": "integer",
"description": "Kolejność rozpatrywania reguł",
"format": "int32"
},
"Notes": {
"maxLength": 500,
"type": "string",
"description": "Uwagi",
"nullable": true
},
"EntityID": {
"type": "integer",
"description": "Uniwersalne ID obiektu",
"format": "int32",
"readOnly": true
},
"___IDCustomer": {
"type": "integer",
"description": "zapisany IDCustomera w formularzu edycyjnym aby była zgodność podczas zapisu",
"format": "int32"
},
"___IsFromDB": {
"type": "boolean",
"description": "Ustawiane podczas odczytu obiektu z bazy danych - jezeli obiekt pochodzi z serializacji z UI powinien miec false\r\nDzieki temu jezeli potrzebujemy historyczny obiekt wiemy czy musimy go pobierac z bazy (jezeli =true) czy wystarczy z cache(=false)"
}
},
"additionalProperties": false,
"description": " Obiekt biznesowy bazujący na Meta_SmartActions_Rules {tabela}\r\n\r\n Opis źródla danych:\r\n Definicje reguł SmartAction / zeroClick - umozliwiajacych detekcje działania w aplikacji uztkownika\r\n\r\n Modyfikacje:\r\n\t\t- wygenerowano AUTOMATYCZNIE [SQL v.1.26]"
},
"SmartActionRuleIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SmartActionRule"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"SourceInvoiceDetails": {
"type": "object",
"properties": {
"General": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralSourceInvoice"
}
],
"description": "General section",
"nullable": true
},
"PaymentDetails": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDetailsSourceInvoice"
}
],
"description": "Payment section",
"nullable": true
}
},
"additionalProperties": false,
"description": "Invoice details section"
},
"SplitVATDetails": {
"type": "object",
"properties": {
"VATBankAccount": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountDetails"
}
],
"description": "Bank account information for VAT payment in base currency or otherwise as recommended for PaymentForTwoCurrencyType field setting",
"nullable": true
},
"PaymentForTwoCurrencyType": {
"allOf": [
{
"$ref": "#/components/schemas/APIPaymentForTwoCurrencyType"
}
],
"description": "Payment type of two currency invoice:\r\n\r\n0 - [Netto] - Netto in currency and VAT in base currency, VATBankAccount has information for VAT payment in base currency\r\n1 - [GrossInCurrency] - Gross in currency, VATBankAccount should be null\r\n2 - [GrossInBaseCurrency] - Gross in base currency, VATBankAccount should be null and BankAccount should be in base currency\r\n3 - [GrossInCurrencyOrBaseCurrency] - Gross in currency or gross in base currency, VATBankAccount should be in base currency and BankAccount should be in invoice currency\r\n\r\nif PaymentForTwoCurrencyType: Netto or for all payment amount in base currency if PaymentForTwoCurrencyType: GrossInBaseCurrency, GrossInCurrencyOrBaseCurrency\n\n0 = Netto\n\n1 = GrossInCurrency\n\n2 = GrossInBaseCurrency\n\n3 = GrossInCurrencyOrBaseCurrency",
"nullable": true
},
"PaymentConversionRate": {
"type": "number",
"description": "Payment conversion rate (only if PaymentForTwoCurrencyType: GrossInBaseCurrency, GrossInCurrencyOrBaseCurrency)",
"format": "double",
"nullable": true
},
"PaymentConversionRateDate": {
"type": "string",
"description": "Payment conversion rate date (only if PaymentForTwoCurrencyType: GrossInBaseCurrency, GrossInCurrencyOrBaseCurrency)",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Split VAT - optional section.\r\nIf appears - invoice should be generated with separation of net value and VAT value (different account) or otherwise as recommended for PaymentForTwoCurrencyType field setting"
},
"StateInfo": {
"type": "object",
"properties": {
"TerminatedBy_UserLogin": {
"maxLength": 200,
"type": "string",
"description": "terminated by user",
"nullable": true
},
"TerminationDate": {
"type": "string",
"description": "termination date",
"format": "date-time",
"nullable": true
},
"TerminationReason": {
"type": "string",
"description": "termination reason",
"nullable": true
},
"SuspendedBy_UserLogin": {
"maxLength": 200,
"type": "string",
"description": "suspended by user",
"nullable": true
},
"SuspendDate": {
"type": "string",
"description": "suspended date",
"format": "date-time",
"nullable": true
},
"SuspendReason": {
"type": "string",
"description": "suspended reason",
"nullable": true
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/APIInvoiceCycleState"
}
],
"description": "invoice cycle state:\r\n\r\n1 - [Active] - Cycle is active - invoice would be generated\r\n2 - [Suspended] - Cycle is temporarily suspended - invoice would NOT be generated\r\n3 - [Terminated] - Cycle is terminated (by user or expired by endDate param) - invoice would NOT be generated\n\n1 = Active\n\n2 = Suspended\n\n3 = Terminated",
"x-enumNames": [
"Active",
"Suspended",
"Terminated"
]
}
},
"additionalProperties": false,
"description": "Invoice cycle state section"
},
"StringAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "string",
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"StringApiResponse": {
"type": "object",
"properties": {
"StatusCode": {
"type": "integer",
"description": "Gets or sets the status code (HTTP status code)",
"format": "int32"
},
"Headers": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Gets or sets the HTTP headers",
"nullable": true
},
"Data": {
"type": "string",
"description": "Gets or sets the data (parsed HTTP body)",
"nullable": true
}
},
"additionalProperties": false,
"description": "API Response"
},
"StringIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"type": "string"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"StringListAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"type": "string"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"StringStringKeyValuePair": {
"type": "object",
"properties": {
"Key": {
"type": "string",
"nullable": true
},
"Value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"StringStringKeyValuePairIEnumerableAPIDataResponse": {
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringStringKeyValuePair"
},
"description": "Response data",
"nullable": true
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/APIResponseStatusType"
}
],
"description": "Status: \r\nOK = 0, Error = 1, Warning = 2\n\n0 = OK\n\n1 = Error\n\n2 = Warning",
"x-enumNames": [
"OK",
"Error",
"Warning"
]
},
"Message": {
"type": "string",
"description": "Message (translated)",
"nullable": true
},
"ErrorCode": {
"type": "integer",
"description": "Error code:\r\n\r\nUnknown = 0, Unauthorized = 1, IncorrectPIN = 2, InvalidIP = 3, \r\nUpdateRequired = 4, NoAccess = 5, ActionFailed = 6, IncorectData = 7,\r\nServiceUnavailable = 8, WrongRequest = 9, TokenExpiredOrInvalid = 10, \r\nAgreementIsNotAccepted = 11, etc.",
"format": "int32",
"nullable": true
},
"AdditionalData": {
"type": "string",
"description": "Additional data\r\nOptional - default null",
"nullable": true
},
"IsStatusOK": {
"type": "boolean",
"description": "if status=OK then true, false otherwise",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response with data"
},
"TagAccounting": {
"type": "object",
"properties": {
"SalesDocumentAccount": {
"type": "string",
"description": "Account number (part) used in booking sales transactions with this tag",
"nullable": true
},
"CostDocumentAccount": {
"type": "string",
"description": "Account number (part) used in booking cost transactions with this tag",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tag accounting information - how to map this tag to account number"
},
"TagGeneral": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Tag name",
"nullable": true
},
"Description": {
"type": "string",
"description": "Tag decription",
"nullable": true
},
"IsDefault": {
"type": "boolean",
"description": "If tag is a default tag in tag classification that is used in accounting - true\r\n\r\nNULL/false - not default",
"nullable": true
},
"IsDisabled": {
"type": "boolean",
"description": "If tag is a disabled for use in documents or invoice - true\r\n\r\nNULL/false - not disabled",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tag general information"
},
"TagGroup": {
"type": "object",
"properties": {
"TagGroupId": {
"type": "integer",
"description": "Tag group ID",
"format": "int32",
"nullable": true
},
"TagGroupName": {
"type": "string",
"description": "Tag group name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tag classification information"
},
"TagGroupGeneral": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Tag group name",
"nullable": true
},
"Description": {
"type": "string",
"description": "Tag group decription",
"nullable": true
},
"SortOrder": {
"type": "integer",
"description": "Tag group sort order",
"format": "int32"
},
"IsPredefined": {
"type": "boolean",
"description": "If tag group is predefined - true\r\n\r\nNULL/false - not predefined",
"nullable": true
},
"IsLocked": {
"type": "boolean",
"description": "If tag group is locked for use in documents or invoice - true\r\n\r\nNULL/false - not disabled",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tag group general information"
},
"TaxAdditionalCosts": {
"type": "object",
"properties": {
"InterestAmountAfterCalculate": {
"type": "number",
"description": "Interest amount after calculate",
"format": "double",
"nullable": true
},
"ReminderCost": {
"type": "number",
"description": "Reminder cost",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Additional costs section"
},
"TaxCorrection": {
"type": "object",
"properties": {
"IsCorrection": {
"type": "boolean",
"description": "If TRUE tax is correction"
},
"CorrectionDate": {
"type": "string",
"description": "If tax is a corretion - date of correction \r\nNULL/empty otherwise",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Additional costs section"
},
"TaxGeneral": {
"type": "object",
"properties": {
"TaxType": {
"allOf": [
{
"$ref": "#/components/schemas/APITaxType"
}
],
"description": "Document Type:\r\n\r\n1 - [PersonalCorporateIncomeTax] - Personal income tax/ Corporate income tax\r\n2 - [ValueAddedTax] - Value-added tax (VAT)\r\n3 - [SocialInsurance] - Social insurance\r\n4 - [Others] - Others\n\n1 = PersonalCorporateIncomeTax\n\n2 = ValueAddedTax\n\n3 = SocialInsurance\n\n4 = Others",
"nullable": true
},
"DeclarationName": {
"type": "string",
"description": "Name of declaration",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double",
"nullable": true
},
"TaxPeriod": {
"type": "string",
"description": "Tax period",
"nullable": true
},
"StartDate": {
"type": "string",
"description": "First day of tax period",
"format": "date-time"
},
"EndDate": {
"type": "string",
"description": "Last day of tax period",
"format": "date-time"
},
"Notes": {
"type": "string",
"description": "Notes",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tax general information"
},
"TaxPayer": {
"type": "object",
"properties": {
"PersonName": {
"type": "string",
"description": "First and last name of the person for the tax\r\nNULL/empty if tax is for company not for person",
"nullable": true
},
"CompanyName": {
"type": "string",
"description": "Name of company for the tax\r\nNULL/empty if tax is for person not for company",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tax recipient details section"
},
"TaxPaymentDetails": {
"type": "object",
"properties": {
"PaymentDeadline": {
"type": "string",
"description": "Payment due date",
"format": "date-time",
"nullable": true
},
"IsPaid": {
"type": "boolean",
"description": "Whether tax has been paid"
},
"PaidAmount": {
"type": "number",
"description": "Paid amount",
"format": "double",
"nullable": true
},
"PaymentDate": {
"type": "string",
"description": "Date of payment",
"format": "date-time",
"nullable": true
},
"LeftToPaid": {
"type": "number",
"description": "Payment amount left to paid",
"format": "double",
"nullable": true
},
"LeftToPaidWithInterest": {
"type": "number",
"description": "Payment amount left to paid with interest amount",
"format": "double"
},
"PaymentTitle": {
"type": "string",
"description": "Payment title",
"nullable": true
},
"OverpaymentType": {
"allOf": [
{
"$ref": "#/components/schemas/APIOverpaymentType"
}
],
"description": "Whether the tax is not overpayment or is overpayment to be settle next month or is overpayment waiting for return\r\n\r\n1 - [IsNotOverpayment] - Tax is not an overpayment\r\n2 - [SettleNextMonth] - Tax will be settle next month\r\n3 - [OverpaymentToReturn] - Overpayment for the tax will be returned\n\n1 = IsNotOverpayment\n\n2 = SettleNextMonth\n\n3 = OverpaymentToReturn",
"x-enumNames": [
"IsNotOverpayment",
"SettleNextMonth",
"OverpaymentToReturn"
]
}
},
"additionalProperties": false,
"description": "Payment section"
},
"TaxRecipientDetails": {
"type": "object",
"properties": {
"RecipientName": {
"type": "string",
"description": "Recipient's name",
"nullable": true
},
"BankAccountNumber": {
"type": "string",
"description": "Recipient's International Bank Account Number (IBAN)",
"nullable": true
},
"Address": {
"type": "string",
"description": "Street name and house numbers associated with the recipient.",
"nullable": true
},
"PostalCodeAndCity": {
"type": "string",
"description": "Postal code and city name associated with the recipient.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Tax recipient details section"
},
"TimesheetDetails": {
"type": "object",
"properties": {
"Filter_ContractorName": {
"type": "string",
"description": "Filters timesheets in which contractor name contains given value",
"nullable": true
},
"Filter_Units": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters timesheets using units",
"nullable": true
},
"Filter_TagsContains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters timesheets which contains given tags",
"nullable": true
},
"Filter_TagsNotContains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters timesheets which not contains given tags",
"nullable": true
},
"Filter_TagsFromGroups": {
"type": "integer",
"description": "Filters timesheets which contains tags from given group",
"format": "int32",
"nullable": true
},
"Set_TagsFromGroups": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Copy tags from timesheets to document only from given groups (leave both Set_TagsFromGroups and Set_AddTags empty to copy all tags)",
"nullable": true
},
"Set_AddTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Always adds given tags to document (leave both Set_TagsFromGroups and Set_AddTags empty to copy all tags)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Alocation key based timesheet - timesheets sections"
},
"UserDetails": {
"type": "object",
"properties": {
"UserId": {
"type": "integer",
"description": "User ID",
"format": "int32"
},
"UserLogin": {
"type": "string",
"description": "User login",
"nullable": true
},
"UserName": {
"type": "string",
"description": "User full name",
"nullable": true
},
"UserAffiliationType": {
"allOf": [
{
"$ref": "#/components/schemas/APIAbsenceRequestAffiliationTypeEnum"
}
],
"description": "User affiliation type\n\n0 = Employee\n\n1 = Partner",
"nullable": true
}
},
"additionalProperties": false,
"description": "User details"
}
},
"securitySchemes": {
"Authorization": {
"type": "apiKey",
"description": "Enter SessionToken (returned by 'authenticate' method in Data element)",
"name": "Authorization",
"in": "header"
}
}
}
}