{
"openapi": "3.0.1",
"info": {
"title": "Zenvoices public API v1",
"description": "The public API of Zenvoices. Refer to https://www.zenvoices.com/blog/public-api-docs/ for additional documentation.",
"version": "public-v1"
},
"paths": {
"/public-api/v1/accounts": {
"get": {
"tags": [
"Account"
],
"summary": "Gets details of an account by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "AccountType",
"in": "query",
"description": "0 (Customer), 1 (Supplier)",
"schema": {
"$ref": "#/components/schemas/AccountType"
}
}
],
"responses": {
"200": {
"description": "Account details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or account doesn't exist."
}
}
},
"post": {
"tags": [
"Account"
],
"summary": "Creates a new account.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountCommand"
}
}
}
},
"responses": {
"200": {
"description": "Account created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"Account"
],
"summary": "Updates an account by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Account updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or account doesn't exist."
}
}
},
"delete": {
"tags": [
"Account"
],
"summary": "Deletes an account by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Account deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or account doesn't exist."
}
}
}
},
"/public-api/v1/accounts/externalId": {
"get": {
"tags": [
"Account"
],
"summary": "Gets details of an account by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "AccountType",
"in": "query",
"description": "0 (Customer), 1 (Supplier)",
"schema": {
"$ref": "#/components/schemas/AccountType"
}
}
],
"responses": {
"200": {
"description": "Account details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or account doesn't exist."
}
}
},
"put": {
"tags": [
"Account"
],
"summary": "Updates an account by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAccountByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Account updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or account doesn't exist."
}
}
},
"delete": {
"tags": [
"Account"
],
"summary": "Deletes an account by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAccountByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Account deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or account doesn't exist."
}
}
}
},
"/public-api/v1/accounts/list": {
"post": {
"tags": [
"Account"
],
"summary": "Gets a list of accounts.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetAccountsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetAccountsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Accounts list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/accountingSystem/getAvailableAccountingSystemConnectors": {
"get": {
"tags": [
"AccountingSystem"
],
"summary": "Gets a list of available accounting system connectors.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AvailableAccountingSystemConnectorDtoListResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AvailableAccountingSystemConnectorDtoListResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AvailableAccountingSystemConnectorDtoListResultDto"
}
}
}
}
}
}
},
"/public-api/v1/administration/list": {
"post": {
"tags": [
"Administration"
],
"summary": "Gets a list of administrations.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ListAdministrationsInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAdministrationsInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ListAdministrationsInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ListAdministrationsInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AdministrationListDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdministrationListDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AdministrationListDtoPagedResultDto"
}
}
}
}
}
}
},
"/public-api/v1/administration/{administrationId}": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets the details of an administration.",
"parameters": [
{
"name": "administrationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Administration details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetAdministrationDetailsOutput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAdministrationDetailsOutput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetAdministrationDetailsOutput"
}
}
}
},
"404": {
"description": "Administration doesn't exist."
}
}
}
},
"/public-api/v1/administration/GetCustomFieldDetails": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets the details of a custom field.",
"parameters": [
{
"name": "CustomFieldLevel",
"in": "query",
"description": "0 (FinancialTransaction), 1 (FinancialTransactionLine)",
"schema": {
"$ref": "#/components/schemas/CustomFieldLevel"
}
},
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Custom field details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
}
}
},
"404": {
"description": "Administration doesn't exist or custom field not found."
}
}
}
},
"/public-api/v1/administration/ManageCustomFieldLookups": {
"post": {
"tags": [
"Administration"
],
"summary": "Updates custom field lookup values.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLookupsCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLookupsCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLookupsCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLookupsCommand"
}
}
}
},
"responses": {
"200": {
"description": "Updated custom field details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
}
}
},
"404": {
"description": "Administration doesn't exist or custom field not found."
}
}
}
},
"/public-api/v1/administration/ManageCustomFieldLedgerAccounts": {
"post": {
"tags": [
"Administration"
],
"summary": "Updates custom field ledger account connections.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLedgerAccountsCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLedgerAccountsCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLedgerAccountsCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ManageCustomFieldLedgerAccountsCommand"
}
}
}
},
"responses": {
"200": {
"description": "Updated custom field details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldPublicAPIDto"
}
}
}
},
"404": {
"description": "Administration doesn't exist or custom field not found."
}
}
}
},
"/public-api/v1/air/processDocument": {
"post": {
"tags": [
"AIR"
],
"summary": "Enqueues a document for processing.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ProcessDocumentInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessDocumentInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProcessDocumentInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ProcessDocumentInput"
}
}
}
},
"responses": {
"202": {
"description": "The operation has been enqueued for processing."
},
"400": {
"description": "Invalid input. Validation messages are added to the response."
},
"500": {
"description": "Error while processing the request. If available an error message is added to the response."
}
}
}
},
"/public-api/v1/air/results/{operationId}": {
"get": {
"tags": [
"AIR"
],
"summary": "Gets the result of a process document operation.",
"parameters": [
{
"name": "operationId",
"in": "path",
"description": "Operation Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Operation result.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetOperationResultOutput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOperationResultOutput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetOperationResultOutput"
}
}
}
},
"404": {
"description": "Operation doesn't exist or has been expired."
}
}
}
},
"/public-api/v1/air/validateOperationResult": {
"post": {
"tags": [
"AIR"
],
"summary": "Validates the results of an operation.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ValidateOperationResultInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateOperationResultInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidateOperationResultInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ValidateOperationResultInput"
}
}
}
},
"responses": {
"404": {
"description": "Operation doesn't exist or has been expired."
},
"202": {
"description": "The operation has been succesfully validated."
}
}
}
},
"/public-api/v1/air/model/createOrUpdate": {
"post": {
"tags": [
"AIRApiModel"
],
"summary": "Creates a new model or updates an existing model.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateAIRApiModelInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateAIRApiModelInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateAIRApiModelInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateAIRApiModelInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateOrEditAIRApiModelOutput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrEditAIRApiModelOutput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrEditAIRApiModelOutput"
}
}
}
}
}
}
},
"/public-api/v1/air/model/delete": {
"post": {
"tags": [
"AIRApiModel"
],
"summary": "Deletes an existing model with its training data.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAIRApiModelInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAIRApiModelInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAIRApiModelInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAIRApiModelInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
}
}
}
}
}
},
"/public-api/v1/air/model/list": {
"post": {
"tags": [
"AIRApiModel"
],
"summary": "Gets a list of models.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ListAIRApiModelsInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAIRApiModelsInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ListAIRApiModelsInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ListAIRApiModelsInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AIRApiModelListDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AIRApiModelListDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AIRApiModelListDtoPagedResultDto"
}
}
}
}
}
}
},
"/public-api/v1/air/model/train": {
"post": {
"tags": [
"AIRApiModel"
],
"summary": "Schedules a model for (re)training.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TrainAIRApiModelInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainAIRApiModelInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TrainAIRApiModelInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TrainAIRApiModelInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
}
}
}
}
}
},
"/public-api/v1/allocationCodes": {
"get": {
"tags": [
"AllocationCode"
],
"summary": "Gets details of an allocation code by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "AllocationAxleCode",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "LedgerAccountCode",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Allocation code details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or allocation code doesn't exist."
}
}
},
"post": {
"tags": [
"AllocationCode"
],
"summary": "Creates a new allocation code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateAllocationCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAllocationCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateAllocationCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateAllocationCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Allocation code created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"AllocationCode"
],
"summary": "Updates an allocation code by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Allocation code updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or allocation code doesn't exist."
}
}
},
"delete": {
"tags": [
"AllocationCode"
],
"summary": "Deletes an allocation code by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Allocation code deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or allocation code doesn't exist."
}
}
}
},
"/public-api/v1/allocationCodes/externalId": {
"get": {
"tags": [
"AllocationCode"
],
"summary": "Gets details of an allocation code by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Allocation code details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or allocation code doesn't exist."
}
}
},
"put": {
"tags": [
"AllocationCode"
],
"summary": "Updates an allocation code by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAllocationCodeByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Allocation code updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or allocation code doesn't exist."
}
}
},
"delete": {
"tags": [
"AllocationCode"
],
"summary": "Deletes an allocation code by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAllocationCodeByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Allocation code deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or allocation code doesn't exist."
}
}
}
},
"/public-api/v1/allocationCodes/list": {
"post": {
"tags": [
"AllocationCode"
],
"summary": "Gets a list of allocation codes.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetAllocationCodesListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAllocationCodesListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetAllocationCodesListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetAllocationCodesListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Allocation codes list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/commitment": {
"get": {
"tags": [
"Commitment"
],
"summary": "Gets details of a commitment by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Commitment details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Commitment doesn't exist."
}
}
},
"post": {
"tags": [
"Commitment"
],
"summary": "Creates a new commitment.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateCommitmentCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCommitmentCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateCommitmentCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateCommitmentCommand"
}
}
}
},
"responses": {
"200": {
"description": "Commitment created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
}
}
},
"put": {
"tags": [
"Commitment"
],
"summary": "Updates a commitment by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Commitment updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Administration id can't be changed. Delete and create a new commitment."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Commitment doesn't exist."
}
}
},
"delete": {
"tags": [
"Commitment"
],
"summary": "Deletes the commitment by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Commitment deleted."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Commitment doesn't exist."
}
}
}
},
"/public-api/v1/commitment/externalId": {
"get": {
"tags": [
"Commitment"
],
"summary": "Gets details of a commitment by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Commitment details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Commitment doesn't exist."
}
}
},
"put": {
"tags": [
"Commitment"
],
"summary": "Updates a commitment by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCommitmentByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Commitment updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Administration id can't be changed. Delete and create a new commitment."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Commitment doesn't exist."
}
}
},
"delete": {
"tags": [
"Commitment"
],
"summary": "Deletes the commitment by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Commitment deleted."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Commitment doesn't exist."
}
}
}
},
"/public-api/v1/commitment/list": {
"post": {
"tags": [
"Commitment"
],
"summary": "Gets a list of commitments.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetCommitmentsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCommitmentsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetCommitmentsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetCommitmentsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Commitments list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
}
}
}
},
"/public-api/v1/costCentres": {
"get": {
"tags": [
"CostCentres"
],
"summary": "Gets details of a cost centre by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Cost centre details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
}
}
},
"post": {
"tags": [
"CostCentres"
],
"summary": "Creates a new cost centre.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateCostCentreCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCostCentreCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateCostCentreCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateCostCentreCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost centre created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"CostCentres"
],
"summary": "Updates a cost centre by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost centre updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
}
}
},
"delete": {
"tags": [
"CostCentres"
],
"summary": "Deletes a cost centre by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost centre deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
}
}
}
},
"/public-api/v1/costCentres/externalId": {
"get": {
"tags": [
"CostCentres"
],
"summary": "Gets details of a cost centre by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Cost centre details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
}
}
},
"put": {
"tags": [
"CostCentres"
],
"summary": "Updates a cost centre by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostCentreByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost centre updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
}
}
},
"delete": {
"tags": [
"CostCentres"
],
"summary": "Deletes a cost centre by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostCentreByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost centre deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
}
}
}
},
"/public-api/v1/costCentres/list": {
"post": {
"tags": [
"CostCentres"
],
"summary": "Gets a list of cost centres.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetCostCentresListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCostCentresListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetCostCentresListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetCostCentresListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Cost centres list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/costUnits": {
"get": {
"tags": [
"CostUnit"
],
"summary": "Gets details of a cost unit by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Cost unit details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost unit doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"post": {
"tags": [
"CostUnit"
],
"summary": "Creates a new cost unit.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateCostUnitCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCostUnitCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateCostUnitCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateCostUnitCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost unit created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"put": {
"tags": [
"CostUnit"
],
"summary": "Updates a cost unit by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost unit updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"delete": {
"tags": [
"CostUnit"
],
"summary": "Deletes a cost unit by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost unit deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost unit doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/costUnits/externalId": {
"get": {
"tags": [
"CostUnit"
],
"summary": "Gets details of a cost unit by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Cost unit details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost unit doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"put": {
"tags": [
"CostUnit"
],
"summary": "Updates a cost unit by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCostUnitByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost unit updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost centre doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"delete": {
"tags": [
"CostUnit"
],
"summary": "Deletes a cost unit by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCostUnitByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Cost unit deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or cost unit doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/costUnits/list": {
"post": {
"tags": [
"CostUnit"
],
"summary": "Gets a list of cost units.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetCostUnitsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCostUnitsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetCostUnitsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetCostUnitsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Cost units list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/countries": {
"get": {
"tags": [
"Country"
],
"summary": "Gets details of a country by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Country details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or country doesn't exist."
}
}
},
"post": {
"tags": [
"Country"
],
"summary": "Creates a new country.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateCountryCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCountryCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateCountryCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateCountryCommand"
}
}
}
},
"responses": {
"200": {
"description": "Country created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"Country"
],
"summary": "Updates a country by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Country updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or country doesn't exist."
}
}
},
"delete": {
"tags": [
"Country"
],
"summary": "Deletes a country by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Country deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or country doesn't exist."
}
}
}
},
"/public-api/v1/countries/externalId": {
"get": {
"tags": [
"Country"
],
"summary": "Gets details of a country by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Country details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or country doesn't exist."
}
}
},
"put": {
"tags": [
"Country"
],
"summary": "Updates a country by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Country updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or country doesn't exist."
}
}
},
"delete": {
"tags": [
"Country"
],
"summary": "Deletes a country by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCountryByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Country deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or country doesn't exist."
}
}
}
},
"/public-api/v1/countries/list": {
"post": {
"tags": [
"Country"
],
"summary": "Gets a list of countries.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetCountriesListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCountriesListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetCountriesListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetCountriesListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Countries list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/currencies": {
"get": {
"tags": [
"Currency"
],
"summary": "Gets details of a currency by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Currency details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or currency doesn't exist."
}
}
},
"post": {
"tags": [
"Currency"
],
"summary": "Creates a new currency.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateCurrencyCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCurrencyCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateCurrencyCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateCurrencyCommand"
}
}
}
},
"responses": {
"200": {
"description": "Currency created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"Currency"
],
"summary": "Updates a currency by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Currency updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or currency not found."
}
}
},
"delete": {
"tags": [
"Currency"
],
"summary": "Deletes a currency by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Currency deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or currency not found."
}
}
}
},
"/public-api/v1/currencies/externalId": {
"get": {
"tags": [
"Currency"
],
"summary": "Gets details of a currency by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Currency details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or currency doesn't exist."
}
}
},
"put": {
"tags": [
"Currency"
],
"summary": "Updates a currency by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrencyByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Currency updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or currency not found."
}
}
},
"delete": {
"tags": [
"Currency"
],
"summary": "Deletes a currency by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteCurrencyByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Currency deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or currency not found."
}
}
}
},
"/public-api/v1/currencies/list": {
"post": {
"tags": [
"Currency"
],
"summary": "Gets a list of currencies.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetCurrenciesListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCurrenciesListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetCurrenciesListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetCurrenciesListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Currencies list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/employees": {
"get": {
"tags": [
"Employee"
],
"summary": "Gets details of an employee by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Employee details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or employee doesn't exist."
}
}
},
"post": {
"tags": [
"Employee"
],
"summary": "Creates a new employee.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateEmployeeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEmployeeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateEmployeeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateEmployeeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Employee created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"Employee"
],
"summary": "Updates an employee by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Employee updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or employee doesn't exist."
}
}
},
"delete": {
"tags": [
"Employee"
],
"summary": "Deletes an employee by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Employee deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or employee doesn't exist."
}
}
}
},
"/public-api/v1/employees/externalId": {
"get": {
"tags": [
"Employee"
],
"summary": "Gets details of an employee by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Employee details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or employee doesn't exist."
}
}
},
"put": {
"tags": [
"Employee"
],
"summary": "Updates an employee by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateEmployeeByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Employee updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or employee doesn't exist."
}
}
},
"delete": {
"tags": [
"Employee"
],
"summary": "Deletes an employee by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteEmployeeByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Employee deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or employee doesn't exist."
}
}
}
},
"/public-api/v1/employees/list": {
"post": {
"tags": [
"Employee"
],
"summary": "Gets a list of employees.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetEmployeesListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetEmployeesListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetEmployeesListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetEmployeesListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Employees list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/financialTransaction/list": {
"post": {
"tags": [
"FinancialTransaction"
],
"summary": "Gets a list of financial transactions.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ListFinancialTransactionsInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFinancialTransactionsInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ListFinancialTransactionsInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ListFinancialTransactionsInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FinancialTransactionListDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialTransactionListDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FinancialTransactionListDtoPagedResultDto"
}
}
}
}
}
}
},
"/public-api/v1/financialTransaction/{financialTransactionId}": {
"get": {
"tags": [
"FinancialTransaction"
],
"summary": "Gets the details of a financial transaction.",
"parameters": [
{
"name": "financialTransactionId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Financial transaction details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetFinancialTransactionDetailsOutput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFinancialTransactionDetailsOutput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetFinancialTransactionDetailsOutput"
}
}
}
},
"404": {
"description": "Financial transaction doesn't exist."
}
}
}
},
"/public-api/v1/financialTransaction/updateExportStatus": {
"put": {
"tags": [
"FinancialTransaction"
],
"summary": "Update the export status of a financial transaction.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateExportStatusCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateExportStatusCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateExportStatusCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateExportStatusCommand"
}
}
}
},
"responses": {
"200": {
"description": "Updated export status."
}
}
}
},
"/public-api/v1/financialTransactionAuthorization/approve": {
"post": {
"tags": [
"FinancialTransactionAuthorization"
],
"parameters": [
{
"name": "FinancialTransactionIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Remark",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/public-api/v1/financialTransactionAuthorization/reject": {
"post": {
"tags": [
"FinancialTransactionAuthorization"
],
"parameters": [
{
"name": "FinancialTransactionIds",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Remark",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "InvoiceResponseMessageRejectClarification",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/public-api/v1/fiscalPeriods": {
"get": {
"tags": [
"FiscalPeriod"
],
"summary": "Gets details of a fiscal period by fiscal year and period.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "FiscalYear",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Period",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Fiscal period details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or fiscal period doesn't exist."
}
}
},
"post": {
"tags": [
"FiscalPeriod"
],
"summary": "Creates a new fiscal period.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateFiscalPeriodCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFiscalPeriodCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateFiscalPeriodCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateFiscalPeriodCommand"
}
}
}
},
"responses": {
"200": {
"description": "Fiscal period created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"FiscalPeriod"
],
"summary": "Updates a fiscal period by fiscal year and period.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByFiscalYearCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByFiscalYearCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByFiscalYearCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByFiscalYearCommand"
}
}
}
},
"responses": {
"200": {
"description": "Fiscal period updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or fiscal period doesn't exist."
}
}
},
"delete": {
"tags": [
"FiscalPeriod"
],
"summary": "Deletes a fiscal period by fiscal year and period.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByFiscalYearCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByFiscalYearCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByFiscalYearCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByFiscalYearCommand"
}
}
}
},
"responses": {
"200": {
"description": "Fiscal period deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or fiscal period doesn't exist."
}
}
}
},
"/public-api/v1/fiscalPeriods/externalId": {
"get": {
"tags": [
"FiscalPeriod"
],
"summary": "Gets details of a fiscal period by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Fiscal period details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or fiscal period doesn't exist."
}
}
},
"put": {
"tags": [
"FiscalPeriod"
],
"summary": "Updates a fiscal period by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateFiscalPeriodByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Fiscal period updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or fiscal period doesn't exist."
}
}
},
"delete": {
"tags": [
"FiscalPeriod"
],
"summary": "Deletes a fiscal period by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteFiscalPeriodByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Fiscal period deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or fiscal period doesn't exist."
}
}
}
},
"/public-api/v1/fiscalPeriods/list": {
"post": {
"tags": [
"FiscalPeriod"
],
"summary": "Gets a list of fiscal periods.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetFiscalPeriodsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFiscalPeriodsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetFiscalPeriodsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetFiscalPeriodsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Fiscal period list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/inbox/details": {
"get": {
"tags": [
"Inbox"
],
"summary": "Gets the details of an inbox document.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "InboxDocumentId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "The inbox documents list",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InboxDocumentDetailsPublicAPIDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboxDocumentDetailsPublicAPIDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InboxDocumentDetailsPublicAPIDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Document was not found."
}
}
}
},
"/public-api/v1/inbox/list": {
"post": {
"tags": [
"Inbox"
],
"summary": "Gets a list of inbox documents.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetInboxDocumentsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetInboxDocumentsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetInboxDocumentsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetInboxDocumentsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "The inbox documents list",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InboxDocumentListPublicAPIDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboxDocumentListPublicAPIDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InboxDocumentListPublicAPIDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
}
}
}
},
"/public-api/v1/inbox/delete": {
"delete": {
"tags": [
"Inbox"
],
"summary": "Deletes an inbox document.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteInboxDocumentCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteInboxDocumentCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteInboxDocumentCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteInboxDocumentCommand"
}
}
}
},
"responses": {
"200": {
"description": "Inbox document was deleted"
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Document was not found."
}
}
}
},
"/public-api/v1/inbox/uploadDocument": {
"post": {
"tags": [
"Inbox"
],
"summary": "Uploads a document.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentInput"
}
}
}
},
"responses": {
"201": {
"description": "The document is successfully uploaded."
}
}
}
},
"/public-api/v1/inbox/uploadDocuments": {
"post": {
"tags": [
"Inbox"
],
"summary": "Uploads documents.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentsInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentsInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentsInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UploadDocumentsInput"
}
}
}
},
"responses": {
"201": {
"description": "The documents are successfully uploaded."
}
}
}
},
"/public-api/v1/ledgerAccounts": {
"get": {
"tags": [
"LedgerAccount"
],
"summary": "Gets details of a ledger account by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Ledger account details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or ledger account doesn't exist."
}
}
},
"post": {
"tags": [
"LedgerAccount"
],
"summary": "Creates a new ledger account.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateLedgerAccountCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLedgerAccountCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateLedgerAccountCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateLedgerAccountCommand"
}
}
}
},
"responses": {
"200": {
"description": "Ledger account created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"LedgerAccount"
],
"summary": "Updates a ledger account by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Ledger account updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or ledger account doesn't exist."
}
}
},
"delete": {
"tags": [
"LedgerAccount"
],
"summary": "Deletes a ledger account by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Ledger account deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or ledger account doesn't exist."
}
}
}
},
"/public-api/v1/ledgerAccounts/externalId": {
"get": {
"tags": [
"LedgerAccount"
],
"summary": "Gets details of a ledger account by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Ledger account details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or ledger account doesn't exist."
}
}
},
"put": {
"tags": [
"LedgerAccount"
],
"summary": "Updates a ledger account by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateLedgerAccountByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Ledger account updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or ledger account doesn't exist."
}
}
},
"delete": {
"tags": [
"LedgerAccount"
],
"summary": "Deletes a ledger account by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLedgerAccountByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Ledger account deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or ledger account doesn't exist."
}
}
}
},
"/public-api/v1/ledgerAccounts/list": {
"post": {
"tags": [
"LedgerAccount"
],
"summary": "Gets a list of ledger accounts.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetLedgerAccountsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLedgerAccountsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetLedgerAccountsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetLedgerAccountsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Ledger accounts list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/masterDataManagement/startUpdate": {
"post": {
"tags": [
"MasterDataManagement"
],
"summary": "Initiates master data update",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/StartMasterDataUpdateCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartMasterDataUpdateCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StartMasterDataUpdateCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/StartMasterDataUpdateCommand"
}
}
}
},
"responses": {
"200": {
"description": "Started master data update"
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found"
}
}
}
},
"/public-api/v1/paymentConditions": {
"get": {
"tags": [
"PaymentCondition"
],
"summary": "Gets details of a payment condition by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Payment condition details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or payment condition doesn't exist."
}
}
},
"post": {
"tags": [
"PaymentCondition"
],
"summary": "Creates a new payment condition.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreatePaymentConditionCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePaymentConditionCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreatePaymentConditionCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreatePaymentConditionCommand"
}
}
}
},
"responses": {
"200": {
"description": "Payment condition created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"PaymentCondition"
],
"summary": "Updates a payment condition by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Payment condition updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or payment condition doesn't exist."
}
}
},
"delete": {
"tags": [
"PaymentCondition"
],
"summary": "Deletes a payment condition by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Payment condition deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or payment condition doesn't exist."
}
}
}
},
"/public-api/v1/paymentConditions/externalId": {
"get": {
"tags": [
"PaymentCondition"
],
"summary": "Gets details of a payment condition by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Payment condition details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or payment condition doesn't exist."
}
}
},
"put": {
"tags": [
"PaymentCondition"
],
"summary": "Updates a payment condition by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentConditionByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Payment condition updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or payment condition doesn't exist."
}
}
},
"delete": {
"tags": [
"PaymentCondition"
],
"summary": "Deletes a payment condition by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeletePaymentConditionByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Payment condition deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or payment condition doesn't exist."
}
}
}
},
"/public-api/v1/paymentConditions/list": {
"post": {
"tags": [
"PaymentCondition"
],
"summary": "Gets a list of payment conditions.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetPaymentConditionsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPaymentConditionsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetPaymentConditionsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetPaymentConditionsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Payment conditions list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/product": {
"get": {
"tags": [
"Product"
],
"summary": "Gets details of a product by product code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Product details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Product doesn't exist."
}
}
},
"post": {
"tags": [
"Product"
],
"summary": "Creates a new product.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateProductCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateProductCommand"
}
}
}
},
"responses": {
"200": {
"description": "Product created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
}
}
},
"put": {
"tags": [
"Product"
],
"summary": "Updates an existing product by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Product updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Administration id can't be changed. Delete and create a new product."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Product doesn't exist."
}
}
},
"delete": {
"tags": [
"Product"
],
"summary": "Deletes a product by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Product deleted."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Product doesn't exist."
}
}
}
},
"/public-api/v1/product/externalId": {
"get": {
"tags": [
"Product"
],
"summary": "Gets details of a product by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Product details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Product doesn't exist."
}
}
},
"put": {
"tags": [
"Product"
],
"summary": "Updates an existing product by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Product updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Administration id can't be changed. Delete and create a new product."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Product doesn't exist."
}
}
},
"delete": {
"tags": [
"Product"
],
"summary": "Deletes a product by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProductByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Product deleted."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Product doesn't exist."
}
}
}
},
"/public-api/v1/product/list": {
"post": {
"tags": [
"Product"
],
"summary": "Gets a list of products.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetProductsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetProductsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetProductsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetProductsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Products list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
}
}
}
},
"/public-api/v1/projects": {
"get": {
"tags": [
"Project"
],
"summary": "Gets details of a project by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Project details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"post": {
"tags": [
"Project"
],
"summary": "Creates a new project.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"put": {
"tags": [
"Project"
],
"summary": "Updates a project by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"delete": {
"tags": [
"Project"
],
"summary": "Deletes a project by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/projects/externalId": {
"get": {
"tags": [
"Project"
],
"summary": "Gets details of a project by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Project details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"put": {
"tags": [
"Project"
],
"summary": "Updates a project by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"delete": {
"tags": [
"Project"
],
"summary": "Deletes a project by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/projects/list": {
"post": {
"tags": [
"Project"
],
"summary": "Gets a list of projects.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetProjectsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetProjectsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetProjectsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetProjectsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Project list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/projectItems": {
"get": {
"tags": [
"ProjectItem"
],
"summary": "Gets details of a project item by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Project item details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project item doesn't exist."
}
}
},
"post": {
"tags": [
"ProjectItem"
],
"summary": "Creates a new project item.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectItemCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectItemCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectItemCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectItemCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project item created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"ProjectItem"
],
"summary": "Updates a project item by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project item updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project item doesn't exist."
}
}
},
"delete": {
"tags": [
"ProjectItem"
],
"summary": "Deletes a project item by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project item deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project item doesn't exist."
}
}
}
},
"/public-api/v1/projectItems/externalId": {
"get": {
"tags": [
"ProjectItem"
],
"summary": "Gets details of a project item by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Project item details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project item doesn't exist."
}
}
},
"put": {
"tags": [
"ProjectItem"
],
"summary": "Updates a project item by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectItemByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project item updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project item doesn't exist."
}
}
},
"delete": {
"tags": [
"ProjectItem"
],
"summary": "Deletes a project item by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectItemByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project item deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project item doesn't exist."
}
}
}
},
"/public-api/v1/projectItems/list": {
"post": {
"tags": [
"ProjectItem"
],
"summary": "Gets a list of project items.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetProjectItemsListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetProjectItemsListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetProjectItemsListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetProjectItemsListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Project items list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/projectStages": {
"get": {
"tags": [
"ProjectStage"
],
"summary": "Gets details of a project stage by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Project stage details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project stage doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"post": {
"tags": [
"ProjectStage"
],
"summary": "Creates a new project stage.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectStageCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectStageCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectStageCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectStageCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project stage created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"put": {
"tags": [
"ProjectStage"
],
"summary": "Updates a project stage by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project stage updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project stage doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"delete": {
"tags": [
"ProjectStage"
],
"summary": "Deletes a project stage by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project stage deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project stage doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/projectStages/externalId": {
"get": {
"tags": [
"ProjectStage"
],
"summary": "Gets details of a project stage by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Project stage details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project stage doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"put": {
"tags": [
"ProjectStage"
],
"summary": "Updates a project stage by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectStageByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project stage updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project stage doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
},
"delete": {
"tags": [
"ProjectStage"
],
"summary": "Deletes a project stage by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteProjectStageByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Project stage deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or project stage doesn't exist."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/projectStages/list": {
"post": {
"tags": [
"ProjectStage"
],
"summary": "Gets a list of project stages.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetProjectStagesListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetProjectStagesListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetProjectStagesListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetProjectStagesListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Project stages list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
},
"500": {
"description": "Administration is not connected to the UBL connector."
}
}
}
},
"/public-api/v1/purchaseOrders": {
"get": {
"tags": [
"PurchaseOrder"
],
"summary": "Gets details of the purchase order by purchase order number",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PurchaseOrderNumber",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Purchase order details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Purchase order doesn't exist."
}
}
},
"post": {
"tags": [
"PurchaseOrder"
],
"summary": "Creates a new purchase order.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreatePurchaseOrderCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePurchaseOrderCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreatePurchaseOrderCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreatePurchaseOrderCommand"
}
}
}
},
"responses": {
"200": {
"description": "Purchase order created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
}
}
},
"put": {
"tags": [
"PurchaseOrder"
],
"summary": "Updates an existing purchase order.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderCommand"
}
}
}
},
"responses": {
"200": {
"description": "Purchase order updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Administration id can't be changed. Delete and create a new purchase order."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Purchase order doesn't exist."
}
}
},
"delete": {
"tags": [
"PurchaseOrder"
],
"summary": "Deletes a purchase order by purchase order number.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderCommand"
}
}
}
},
"responses": {
"200": {
"description": "Purchase order deleted."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Purchase order doesn't exist."
}
}
}
},
"/public-api/v1/purchaseOrders/externalId": {
"get": {
"tags": [
"PurchaseOrder"
],
"summary": "Gets details of the purchase order by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Purchase order details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Purchase order doesn't exist."
}
}
},
"put": {
"tags": [
"PurchaseOrder"
],
"summary": "Updates an existing purchase order by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdatePurchaseOrderByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Purchase order updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Administration id can't be changed. Delete and create a new purchase order."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Purchase order doesn't exist."
}
}
},
"delete": {
"tags": [
"PurchaseOrder"
],
"summary": "Deletes a purchase order by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeletePurchaseOrderByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Purchase order deleted."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Purchase order order doesn't exist."
}
}
}
},
"/public-api/v1/purchaseOrders/list": {
"post": {
"tags": [
"PurchaseOrder"
],
"summary": "Gets a list of purchase orders.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetPurchaseOrdersListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPurchaseOrdersListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetPurchaseOrdersListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetPurchaseOrdersListQuery"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDtoPagedResultDto"
}
}
}
}
}
}
},
"/public-api/v1/taxCodes": {
"get": {
"tags": [
"TaxCode"
],
"summary": "Gets details of a tax code by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Tax code details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax code doesn't exist."
}
}
},
"post": {
"tags": [
"TaxCode"
],
"summary": "Creates a new tax code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax code created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"TaxCode"
],
"summary": "Updates a tax code by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax code updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax code doesn't exist."
}
}
},
"delete": {
"tags": [
"TaxCode"
],
"summary": "Deletes a tax code by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax code deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax code doesn't exist."
}
}
}
},
"/public-api/v1/taxCodes/externalId": {
"get": {
"tags": [
"TaxCode"
],
"summary": "Gets details of a tax code by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Tax code details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax code doesn't exist."
}
}
},
"put": {
"tags": [
"TaxCode"
],
"summary": "Updates a tax code by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxCodeByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax code updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax code doesn't exist."
}
}
},
"delete": {
"tags": [
"TaxCode"
],
"summary": "Deletes a tax code by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxCodeByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax code deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax code doesn't exist."
}
}
}
},
"/public-api/v1/taxCodes/list": {
"post": {
"tags": [
"TaxCode"
],
"summary": "Gets a list of tax codes.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetTaxCodesListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTaxCodesListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetTaxCodesListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetTaxCodesListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Tax codes list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/public-api/v1/taxScenarios": {
"get": {
"tags": [
"TaxScenario"
],
"summary": "Gets details of a tax scenario by code.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "FiscalYear",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Tax scenario details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax scenario doesn't exist."
}
}
},
"post": {
"tags": [
"TaxScenario"
],
"summary": "Creates a new tax scenario.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxScenarioCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxScenarioCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxScenarioCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxScenarioCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax scenario created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
},
"put": {
"tags": [
"TaxScenario"
],
"summary": "Updates a tax scenario by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax scenario updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax scenario doesn't exist."
}
}
},
"delete": {
"tags": [
"TaxScenario"
],
"summary": "Deletes a tax scenario by code.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByCodeCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByCodeCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByCodeCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByCodeCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax scenario deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax scenario doesn't exist."
}
}
}
},
"/public-api/v1/taxScenarios/externalId": {
"get": {
"tags": [
"TaxScenario"
],
"summary": "Gets details of a tax scenario by external id.",
"parameters": [
{
"name": "AdministrationId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ExternalId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Tax scenario details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax scenario doesn't exist."
}
}
},
"put": {
"tags": [
"TaxScenario"
],
"summary": "Updates a tax scenario by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaxScenarioByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax scenario updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
}
}
}
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax scenario doesn't exist."
}
}
},
"delete": {
"tags": [
"TaxScenario"
],
"summary": "Deletes a tax scenario by external id.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByExternalIdCommand"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByExternalIdCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByExternalIdCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteTaxScenarioByExternalIdCommand"
}
}
}
},
"responses": {
"200": {
"description": "Tax scenario deleted."
},
"400": {
"description": "Validation errors."
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found or tax scenario doesn't exist."
}
}
}
},
"/public-api/v1/taxScenarios/list": {
"post": {
"tags": [
"TaxScenario"
],
"summary": "Gets a list of tax scenarios.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/GetTaxScenariosListQuery"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTaxScenariosListQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetTaxScenariosListQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GetTaxScenariosListQuery"
}
}
}
},
"responses": {
"200": {
"description": "Tax scenarios list.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDtoPagedResultDto"
}
}
}
},
"403": {
"description": "Doesn't have access to the administration."
},
"404": {
"description": "Administration not found."
}
}
}
},
"/api/Account/Authenticate": {
"post": {
"tags": [
"TokenAuth"
],
"summary": "Legacy authentication endpoint for the public API.\r\nConsumes application/json.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AjaxResponse"
}
}
}
}
}
}
},
"/api/TokenAuth/TokenLogin": {
"post": {
"tags": [
"TokenAuth"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AuthenticateResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateResult"
}
}
}
}
}
}
},
"/api/TokenAuth/RefreshToken": {
"post": {
"tags": [
"TokenAuth"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenResult"
}
}
}
}
}
}
},
"/api/TokenAuth/SendTwoFactorAuthCode": {
"post": {
"tags": [
"TokenAuth"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SendTwoFactorAuthCodeInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendTwoFactorAuthCodeInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SendTwoFactorAuthCodeInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SendTwoFactorAuthCodeInput"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/TokenAuth/ExternalLogin": {
"get": {
"tags": [
"TokenAuth"
],
"parameters": [
{
"name": "provider",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "returnUrl",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "tenancyName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "isMobile",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/public-api/v1/user/list": {
"post": {
"tags": [
"User"
],
"summary": "Gets a list of users.",
"parameters": [
{
"name": "MaxResultCount",
"in": "query",
"schema": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "SkipCount",
"in": "query",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Sorting",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserListDtoPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserListDtoPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserListDtoPagedResultDto"
}
}
}
}
}
}
},
"/public-api/v1/user/{userId}": {
"get": {
"tags": [
"User"
],
"summary": "Gets the details of a user.",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "User details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetUserDetailsOutput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserDetailsOutput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetUserDetailsOutput"
}
}
}
},
"404": {
"description": "User doesn't exist."
}
}
}
},
"/public-api/v1/webhookSubscription/list": {
"get": {
"tags": [
"WebhookSubscription"
],
"summary": "Returns the list of an webhook subscriptions.",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WebhookSubscriptionListDtoListResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookSubscriptionListDtoListResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WebhookSubscriptionListDtoListResultDto"
}
}
}
}
}
}
},
"/public-api/v1/webhookSubscription/{subscriptionId}": {
"get": {
"tags": [
"WebhookSubscription"
],
"summary": "Returns details of the webhook subscription",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Webhook subscription details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ZenvoicesWebhookSubscriptionDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ZenvoicesWebhookSubscriptionDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ZenvoicesWebhookSubscriptionDto"
}
}
}
},
"404": {
"description": "Webhook subscription doesn't exist."
}
}
}
},
"/public-api/v1/webhookSubscription": {
"post": {
"tags": [
"WebhookSubscription"
],
"summary": "Creates new webhook subscription",
"parameters": [
{
"name": "WebhookUri",
"in": "query",
"description": "The endpoint where webhooks will be published. An \"https\" uri is required.",
"schema": {
"type": "string"
}
},
{
"name": "IsActive",
"in": "query",
"description": "Active or inactive state of the webhook subscription.",
"schema": {
"type": "boolean"
}
},
{
"name": "Name",
"in": "query",
"description": "Name of the webhook subscription",
"schema": {
"type": "string"
}
},
{
"name": "Headers",
"in": "query",
"description": "The dictionary (key, value) of headers that should be sent with every request. Max 10 pairs are accepted.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
}
}
},
{
"name": "AdministrationIds",
"in": "query",
"description": "The list of administration ids to which the webhook subscription should be applied.",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Webhooks",
"in": "query",
"description": "The list of webhook event names. \r\nAvailable webhook event names can be retrieved using GetAvailableWebhooks endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "The webhook subscription successfully created. The id is returned",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"400": {
"description": "The input is invalid."
}
}
},
"put": {
"tags": [
"WebhookSubscription"
],
"parameters": [
{
"name": "Id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "WebhookUri",
"in": "query",
"description": "The endpoint where webhooks will be published. An \"https\" uri is required.",
"schema": {
"type": "string"
}
},
{
"name": "IsActive",
"in": "query",
"description": "Active or inactive state of the webhook subscription.",
"schema": {
"type": "boolean"
}
},
{
"name": "Name",
"in": "query",
"description": "Name of the webhook subscription",
"schema": {
"type": "string"
}
},
{
"name": "Headers",
"in": "query",
"description": "The dictionary (key, value) of headers that should be sent with every request. Max 10 pairs are accepted.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
}
}
},
{
"name": "AdministrationIds",
"in": "query",
"description": "The list of administration ids to which the webhook subscription should be applied.",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Webhooks",
"in": "query",
"description": "The list of webhook event names. \r\nAvailable webhook event names can be retrieved using GetAvailableWebhooks endpoint.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"WebhookSubscription"
],
"summary": "Deletes the webhook subscription",
"parameters": [
{
"name": "Id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The webhook subscription successfully deleted."
},
"400": {
"description": "Webhook subscription id is invalid."
},
"404": {
"description": "Webhook subscription doesn't exist."
}
}
}
},
"/public-api/v1/webhookSubscription/test-webhook-subscription": {
"get": {
"tags": [
"WebhookSubscription"
],
"summary": "Send test webhook event publish to selected webhook subscription.\r\nDepending on the server load, the request can be delayed.",
"parameters": [
{
"name": "Id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The test webhook event successfully published."
},
"400": {
"description": "Webhook subscription id is invalid."
},
"404": {
"description": "Webhook subscription doesn't exist."
}
}
}
},
"/public-api/v1/webhookSubscription/send-attempts": {
"post": {
"tags": [
"WebhookSubscription"
],
"summary": "Returns the paged list of webhook subscription send attempts.",
"parameters": [
{
"name": "SubscriptionId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "MaxResultCount",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "SkipCount",
"in": "query",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "List of webhook subscription send attempts.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetAllSendAttemptsOutputPagedResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAllSendAttemptsOutputPagedResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetAllSendAttemptsOutputPagedResultDto"
}
}
}
},
"400": {
"description": "Webhook subscription id is invalid."
}
}
}
},
"/public-api/v1/webhookSubscription/resend-webhook": {
"post": {
"tags": [
"WebhookSubscription"
],
"summary": "Resends the webhook send attempt, in case of failure. Only one attempt is tried.",
"parameters": [
{
"name": "sendAttemptId",
"in": "query",
"description": "The id of send attempt",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The webhook send attempt successfully resent."
},
"404": {
"description": "Webhook send attempt not found."
}
}
}
},
"/public-api/v1/webhookSubscription/get-available-webhooks": {
"get": {
"tags": [
"WebhookSubscription"
],
"summary": "Returns the list of all available webhook event names",
"responses": {
"200": {
"description": "Available webhook event names",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WebhookListDtoListResultDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookListDtoListResultDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WebhookListDtoListResultDto"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AIRApiModelEditDto": {
"type": "object",
"properties": {
"modelId": {
"type": "string",
"description": "Id of the model. Don't set when creating a new model.",
"format": "uuid",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"description": "Description of the model.",
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiModelListDto": {
"type": "object",
"properties": {
"modelId": {
"type": "string",
"description": "Id of the model.",
"format": "uuid"
},
"description": {
"type": "string",
"description": "Description of the model.",
"nullable": true
},
"lastTrainingTime": {
"type": "string",
"description": "Last time the model was trained.",
"format": "date-time",
"nullable": true
},
"isTrainingScheduled": {
"type": "boolean",
"description": "Bool indicating if training is scheduled."
}
},
"additionalProperties": false
},
"AIRApiModelListDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiModelListDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AIRApiOperationDto": {
"type": "object",
"properties": {
"operationId": {
"type": "string",
"description": "Operation id.",
"format": "uuid"
},
"status": {
"$ref": "#/components/schemas/AIRApiOperationStatus"
},
"statusChangeTime": {
"type": "string",
"description": "Date time on which the status was last changed.",
"format": "date-time",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message (only present if status is Zenvoices.AIR.AIRApiOperationStatus.Failed).",
"nullable": true
},
"billingTransactionUsage": {
"type": "integer",
"description": "Number of billed transactions for the operation (only present if status is Zenvoices.AIR.AIRApiOperationStatus.Succeeded).",
"format": "int32"
}
},
"additionalProperties": false
},
"AIRApiOperationStatus": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "0 (Queued), 1 (Running), 2 (Succeeded), 3 (Failed)",
"format": "int32",
"x-enumNames": [
"Queued",
"Running",
"Succeeded",
"Failed"
]
},
"AIRApiRawTableInfo": {
"type": "object",
"properties": {
"tableX0": {
"type": "number",
"format": "float"
},
"tableX1": {
"type": "number",
"format": "float"
},
"tableY0": {
"type": "number",
"format": "float"
},
"tableY1": {
"type": "number",
"format": "float"
},
"pageNumber": {
"type": "integer",
"format": "int32"
},
"confidence": {
"type": "number",
"format": "float"
},
"isContinuation": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AIRApiRawTableOutput": {
"type": "object",
"properties": {
"tableInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiRawTableInfo"
},
"nullable": true
},
"tableStructures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiRawTableStructure"
},
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiRawTableStructure": {
"type": "object",
"properties": {
"headerClasses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiTableHeader"
},
"nullable": true
},
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiTableRow"
},
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiRectangle": {
"type": "object",
"properties": {
"left": {
"type": "number",
"format": "float"
},
"top": {
"type": "number",
"format": "float"
},
"right": {
"type": "number",
"format": "float"
},
"bottom": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"additionalProperties": false
},
"AIRApiResult": {
"type": "object",
"properties": {
"documentInformation": {
"$ref": "#/components/schemas/AIRApiResultDocumentInformation"
},
"extractedValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiResultExtractedValueWithFieldName"
},
"nullable": true
},
"pages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiResultPage"
},
"nullable": true
},
"extractedLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiResultLineItem"
},
"nullable": true
},
"rawTableOutput": {
"$ref": "#/components/schemas/AIRApiRawTableOutput"
}
},
"additionalProperties": false
},
"AIRApiResultDocumentInformation": {
"type": "object",
"properties": {
"cultureCode": {
"type": "string",
"nullable": true
},
"pageCount": {
"type": "integer",
"format": "int32"
},
"identifiedLanguages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiResultIdentifiedLanguage"
},
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiResultExtractedValue": {
"type": "object",
"properties": {
"parsedValue": {
"type": "string",
"nullable": true
},
"rawValue": {
"type": "string",
"nullable": true
},
"confidence": {
"type": "number",
"format": "float",
"nullable": true
},
"pageNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rectangle": {
"$ref": "#/components/schemas/AIRApiRectangle"
},
"groupId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiResultExtractedValueWithFieldName": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiResultExtractedValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiResultIdentifiedLanguage": {
"type": "object",
"properties": {
"language": {
"type": "string",
"nullable": true
},
"probability": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"AIRApiResultLineItem": {
"type": "object",
"properties": {
"confidence": {
"type": "number",
"format": "double"
},
"orderNumber": {
"type": "string",
"nullable": true
},
"referenceNumber": {
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"productCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"taxAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"taxRate": {
"type": "number",
"format": "double",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiResultPage": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"format": "int32"
},
"isProcessedByOcr": {
"type": "boolean"
},
"rawText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiTableCell": {
"type": "object",
"properties": {
"rectangle": {
"$ref": "#/components/schemas/AIRApiRectangle"
},
"rawText": {
"type": "string",
"nullable": true
},
"parsedText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiTableHeader": {
"required": [
"tableHeaderHeaderName"
],
"type": "object",
"properties": {
"tableHeaderHeaderName": {
"minLength": 1,
"type": "string"
},
"tableHeaderDataType": {
"$ref": "#/components/schemas/TableHeaderType"
},
"confidence": {
"type": "number",
"format": "float"
}
},
"additionalProperties": false
},
"AIRApiTableHeaderValidation": {
"type": "object",
"properties": {
"tableHeaderName": {
"type": "string",
"description": "Table header name for this cell (see docs for valid table header names).",
"nullable": true
}
},
"additionalProperties": false
},
"AIRApiTableRow": {
"type": "object",
"properties": {
"cells": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiTableCell"
},
"nullable": true
},
"isHeader": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AIRResultLineItemDto": {
"type": "object",
"properties": {
"confidence": {
"type": "number",
"format": "double"
},
"yourOrderNumber": {
"type": "string",
"nullable": true
},
"referenceNumber": {
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"productCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"taxAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"taxRate": {
"type": "number",
"format": "double",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"customRecognitionFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionExtractedCustomRecognitionLineFieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"AIRResultMatchedAccountDto": {
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"nullable": true
},
"telephone": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"accountCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AIRResultTaxLineDto": {
"type": "object",
"properties": {
"taxRate": {
"type": "number",
"format": "double",
"nullable": true
},
"taxAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"taxBaseAmount": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"AccountAddressPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
},
"addressLine1": {
"type": "string",
"nullable": true
},
"addressLine2": {
"type": "string",
"nullable": true
},
"addressLine3": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"streetNumber": {
"type": "string",
"nullable": true
},
"streetNumberExtension": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"telephone": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AccountAddressPublicAPIEditDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
},
"addressLine1": {
"type": "string",
"nullable": true
},
"addressLine2": {
"type": "string",
"nullable": true
},
"addressLine3": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"streetNumber": {
"type": "string",
"nullable": true
},
"streetNumberExtension": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"telephone": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AccountDefaultFinancialTransactionTypeSetting": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Automatic), 1 (JournalEntry), 2 (PurchaseInvoice)",
"format": "int32",
"x-enumNames": [
"Automatic",
"JournalEntry",
"PurchaseInvoice"
]
},
"AccountPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
},
"searchCode": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"vatNumber": {
"type": "string",
"nullable": true
},
"chamberOfCommerceNumber": {
"type": "string",
"nullable": true
},
"iban": {
"type": "string",
"nullable": true
},
"bic": {
"type": "string",
"nullable": true
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"paymentDueDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"paymentConditionCode": {
"type": "string",
"nullable": true
},
"taxScenarioCode": {
"type": "string",
"nullable": true
},
"accountAddress": {
"$ref": "#/components/schemas/AccountAddressPublicAPIDetailsDto"
},
"includeInSupplierPaymentBatches": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"financialTransactionProposalStrategy": {
"$ref": "#/components/schemas/FinancialTransactionProposalStrategy"
},
"dontAskToUpdateMasterData": {
"type": "boolean"
},
"isFinancialTransactionIBANCheckEnabled": {
"type": "boolean"
},
"isFinancialTransactionVATNumberCheckEnabled": {
"type": "boolean"
},
"includeInInternalPaymentBatch": {
"type": "boolean"
},
"defaultFinancialTransactionType": {
"$ref": "#/components/schemas/AccountDefaultFinancialTransactionTypeSetting"
},
"paymentDiscountPercentage": {
"type": "number",
"format": "double"
},
"externalPaymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountTaxCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountTaxCalculationMethod"
},
"scanAndRecognizeDocumentTypeRecognitionMethod": {
"$ref": "#/components/schemas/ScanAndRecognizeDocumentTypeRecognitionMethod"
},
"scanAndRecognizeDateParsingPreference": {
"$ref": "#/components/schemas/ScanAndRecognizeDateParsingPreference"
},
"gAccountAmountCalculationMode": {
"$ref": "#/components/schemas/FinancialTransactionGAccountAmountCalculationMode"
},
"gAccountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAccountCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AccountPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AccountType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Customer), 1 (Supplier)",
"format": "int32",
"x-enumNames": [
"Customer",
"Supplier"
]
},
"AdministrationCustomFieldDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/CustomFieldType"
}
},
"additionalProperties": false
},
"AdministrationDetailsDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/AdministrationType"
},
"isActive": {
"type": "boolean"
},
"accountingSystemConnectorName": {
"type": "string",
"nullable": true
},
"accountingSystemAdministrationId": {
"type": "string",
"nullable": true
},
"emailAddressAlias": {
"type": "string",
"nullable": true
},
"defaultEmailAddressJournalId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"journals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalListDto"
},
"nullable": true
},
"enabledFeatures": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"tagNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"financialTransactionHeaderCustomFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdministrationCustomFieldDto"
},
"nullable": true
},
"financialTransactionLineCustomFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdministrationCustomFieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"AdministrationListDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/AdministrationType"
},
"isActive": {
"type": "boolean"
},
"accountingSystemConnectorName": {
"type": "string",
"nullable": true
},
"accountingSystemAdministrationId": {
"type": "string",
"nullable": true
},
"tagNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"AdministrationListDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdministrationListDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AdministrationType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Premium), 1 (Lite)",
"format": "int32",
"x-enumNames": [
"Premium",
"Lite"
]
},
"AjaxResponse": {
"type": "object",
"properties": {
"targetUrl": {
"type": "string",
"nullable": true
},
"success": {
"type": "boolean"
},
"error": {
"$ref": "#/components/schemas/ErrorInfo"
},
"unAuthorizedRequest": {
"type": "boolean"
},
"__abp": {
"type": "boolean",
"readOnly": true
},
"result": {
"nullable": true
}
},
"additionalProperties": false
},
"AllocationCodePublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"allocationAxleCode": {
"type": "string",
"nullable": true
},
"allocationAxleDescription": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"AllocationCodePublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllocationCodePublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ApproveFinancialTransactionsCommand": {
"required": [
"financialTransactionIds"
],
"type": "object",
"properties": {
"financialTransactionIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"remark": {
"maxLength": 10000,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AttachmentDto": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"nullable": true
},
"storageId": {
"type": "string",
"format": "uuid"
},
"sasUri": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AttachmentKind": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (ImportAttachment), 1 (OtherAttachment), 2 (EmailAttachment)",
"format": "int32",
"x-enumNames": [
"ImportAttachment",
"OtherAttachment",
"EmailAttachment"
]
},
"AuthenticateInput": {
"required": [
"password",
"userNameOrEmailAddress"
],
"type": "object",
"properties": {
"userNameOrEmailAddress": {
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"password": {
"minLength": 1,
"type": "string"
},
"tenancyName": {
"maxLength": 64,
"minLength": 0,
"type": "string",
"nullable": true
},
"twoFactorVerificationCode": {
"type": "string",
"nullable": true
},
"loginVerificationCode": {
"type": "string",
"nullable": true
},
"isTwoFactorVerification": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"AuthenticateResult": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"nullable": true
},
"expireInSeconds": {
"type": "integer",
"format": "int32"
},
"accessTokenExpirationDateTimeUtc": {
"type": "string",
"format": "date-time"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"loginVerificationCode": {
"type": "string",
"nullable": true
},
"requiresTwoFactorVerification": {
"type": "boolean"
},
"twoFactorAuthProviders": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"twoFactorAuthProvidersSelectList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SelectListItem"
},
"nullable": true
},
"refreshToken": {
"type": "string",
"nullable": true
},
"refreshTokenExpireInSeconds": {
"type": "integer",
"format": "int32"
},
"refreshTokenExpirationDateTimeUtc": {
"type": "string",
"format": "date-time"
},
"encryptedAccessToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AvailableAccountingSystemConnectorDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"displayName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AvailableAccountingSystemConnectorDtoListResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableAccountingSystemConnectorDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"CommitmentPublicAPIDetailsDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"internalReference": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"contractName": {
"type": "string",
"nullable": true
},
"accountCode": {
"type": "string",
"description": "Supplier account code",
"nullable": true
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"productCode": {
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"projectCode": {
"type": "string",
"nullable": true
},
"projectItemCode": {
"type": "string",
"nullable": true
},
"projectStageCode": {
"type": "string",
"nullable": true
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"fiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"periodStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"openAmount": {
"type": "number",
"format": "double"
},
"allocationAxleCode1": {
"type": "string",
"nullable": true
},
"allocationAxleCode2": {
"type": "string",
"nullable": true
},
"allocationAxleCode3": {
"type": "string",
"nullable": true
},
"allocationAxleCode4": {
"type": "string",
"nullable": true
},
"allocationAxleCode5": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CommitmentPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommitmentPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CostCentrePublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CostCentrePublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostCentrePublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CostType": {
"enum": [
0,
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,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52
],
"type": "integer",
"description": "0 (NotRecognized), 1 (AdministrativeCosts), 2 (AccountantAdvisoryCosts), 3 (InsuranceCosts), 4 (OrganizationCosts), 5 (OfficeCosts), 6 (TransportCosts), 7 (FuelCosts), 8 (CarTransportCosts), 9 (AdvertisingCosts), 10 (SponsoringCosts), 11 (FairCosts), 12 (RelationGifts), 13 (ChristmasPackages), 14 (RepresentationCosts), 15 (TravelExpenses), 16 (DisplayCosts), 17 (FreightCosts), 18 (SalesCommission), 19 (Commissions), 20 (FranchiseCosts), 21 (WebsiteCosts), 22 (OtherSalesCosts), 23 (MachineCosts), 24 (HousingOtherCosts), 25 (RentCosts), 26 (CleaningCosts), 27 (ServiceCosts), 28 (SecurityCosts), 29 (Utilities), 30 (TemporaryWorkers), 31 (ManagementFee), 32 (RecruitmentCosts), 33 (StaffOutingsGifts), 34 (TrainingCosts), 35 (OtherCosts), 36 (BankInterestCosts), 37 (BusinessTaxes), 38 (SmallPurchases), 39 (OfficeSupplies), 40 (PrintingPaper), 41 (PostageCosts), 42 (TelephoneCosts), 43 (InternetCosts), 44 (VehicleTax), 45 (LeaseCars), 46 (RentCars), 47 (TaxPenalties), 48 (PurchaseGoods), 49 (SoftwareSaasCosts), 50 (ContractedPersonnelCosts), 51 (PensionCosts), 52 (RestaurantCosts)",
"format": "int32",
"x-enumNames": [
"NotRecognized",
"AdministrativeCosts",
"AccountantAdvisoryCosts",
"InsuranceCosts",
"OrganizationCosts",
"OfficeCosts",
"TransportCosts",
"FuelCosts",
"CarTransportCosts",
"AdvertisingCosts",
"SponsoringCosts",
"FairCosts",
"RelationGifts",
"ChristmasPackages",
"RepresentationCosts",
"TravelExpenses",
"DisplayCosts",
"FreightCosts",
"SalesCommission",
"Commissions",
"FranchiseCosts",
"WebsiteCosts",
"OtherSalesCosts",
"MachineCosts",
"HousingOtherCosts",
"RentCosts",
"CleaningCosts",
"ServiceCosts",
"SecurityCosts",
"Utilities",
"TemporaryWorkers",
"ManagementFee",
"RecruitmentCosts",
"StaffOutingsGifts",
"TrainingCosts",
"OtherCosts",
"BankInterestCosts",
"BusinessTaxes",
"SmallPurchases",
"OfficeSupplies",
"PrintingPaper",
"PostageCosts",
"TelephoneCosts",
"InternetCosts",
"VehicleTax",
"LeaseCars",
"RentCars",
"TaxPenalties",
"PurchaseGoods",
"SoftwareSaasCosts",
"ContractedPersonnelCosts",
"PensionCosts",
"RestaurantCosts"
]
},
"CostUnitPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CostUnitPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostUnitPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CountryPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CountryPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CreateAccountCommand": {
"required": [
"accountAddress",
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
},
"searchCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"vatNumber": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"chamberOfCommerceNumber": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"iban": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"bic": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"paymentDueDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"paymentConditionCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxScenarioCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"accountAddress": {
"$ref": "#/components/schemas/AccountAddressPublicAPIEditDto"
},
"includeInSupplierPaymentBatches": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"financialTransactionProposalStrategy": {
"$ref": "#/components/schemas/FinancialTransactionProposalStrategy"
},
"dontAskToUpdateMasterData": {
"type": "boolean"
},
"isFinancialTransactionIBANCheckEnabled": {
"type": "boolean"
},
"isFinancialTransactionVATNumberCheckEnabled": {
"type": "boolean"
},
"includeInInternalPaymentBatch": {
"type": "boolean"
},
"defaultFinancialTransactionType": {
"$ref": "#/components/schemas/AccountDefaultFinancialTransactionTypeSetting"
},
"paymentDiscountPercentage": {
"type": "number",
"format": "double"
},
"externalPaymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountTaxCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountTaxCalculationMethod"
},
"scanAndRecognizeDocumentTypeRecognitionMethod": {
"$ref": "#/components/schemas/ScanAndRecognizeDocumentTypeRecognitionMethod"
},
"scanAndRecognizeDateParsingPreference": {
"$ref": "#/components/schemas/ScanAndRecognizeDateParsingPreference"
},
"gAccountAmountCalculationMode": {
"$ref": "#/components/schemas/FinancialTransactionGAccountAmountCalculationMode"
},
"gAccountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CreateAllocationCodeCommand": {
"required": [
"administrationId",
"allocationAxleCode",
"code",
"externalId",
"ledgerAccountCode"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"allocationAxleCode": {
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"allocationAxleDescription": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"code": {
"maxLength": 20,
"minLength": 1,
"type": "string"
},
"description": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateCommitmentCommand": {
"required": [
"accountCode",
"administrationId",
"code"
],
"type": "object",
"properties": {
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"type": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"reference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"internalReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"externalReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"contractName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"accountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"productCode": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"projectCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"projectItemCode": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectStageCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"fiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"periodStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"openAmount": {
"type": "number",
"format": "double"
},
"allocationAxleCode1": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode2": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode3": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode4": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode5": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"externalId": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateCostCentreCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateCostUnitCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateCountryCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 10,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateCurrencyCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"priceNumberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateEmployeeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"fullName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"costCentreCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateFiscalPeriodCommand": {
"required": [
"administrationId",
"externalId",
"fiscalYear"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"fiscalYear": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"period": {
"minimum": 0,
"type": "integer",
"format": "int32"
},
"description": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateLedgerAccountCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"isCostCentreEntryRequired": {
"type": "boolean"
},
"isCostUnitEntryRequired": {
"type": "boolean"
},
"isProductEntryRequired": {
"type": "boolean"
},
"isEmployeeEntryRequired": {
"type": "boolean"
},
"projectEntryConstraint": {
"$ref": "#/components/schemas/LedgerAccountProjectEntryConstraint"
},
"isTaxCodeAllowed": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/LedgerAccountType"
},
"isAFASAllocationAxle1EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle2EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle3EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle4EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle5EntryRequired": {
"type": "boolean"
},
"isCommitmentEntryInPurchaseTransactionsRequired": {
"type": "boolean"
},
"isTaxNonDeductiblePercentageChangingAllowed": {
"type": "boolean"
},
"isPrivateUsePercentageChangingAllowed": {
"type": "boolean"
},
"deductibilityPercentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountDeductibilityPercentagePublicAPIDto"
},
"nullable": true
},
"classifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountClassificationPublicAPIDto"
},
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateOrEditAIRApiModelOutput": {
"type": "object",
"properties": {
"modelId": {
"type": "string",
"description": "Id of the created model.",
"format": "uuid"
}
},
"additionalProperties": false
},
"CreateOrUpdateAIRApiModelInput": {
"required": [
"model"
],
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/AIRApiModelEditDto"
}
},
"additionalProperties": false
},
"CreatePaymentConditionCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"paymentDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentMonths": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/PaymentConditionType"
},
"paymentMethod": {
"$ref": "#/components/schemas/PaymentConditionPaymentMethod"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateProductCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"code": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "User friendly product code. Has to be unique within one administration."
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"name": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"application": {
"$ref": "#/components/schemas/ProductApplication"
},
"salesUnit": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"salesPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"salesTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"salesLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"purchaseUnit": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"purchasePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"purchaseLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"quantityNumberOfDecimals": {
"maximum": 6,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"priceNumberOfDecimals": {
"maximum": 6,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"administrationId": {
"type": "integer",
"description": "Administration id of the product",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "Id from the external system. Has to be unique within one administration."
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateProjectCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"purchaseTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"projectLeaderFullName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateProjectItemCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateProjectStageCommand": {
"required": [
"administrationId",
"code",
"externalId",
"projectCode"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreatePurchaseOrderCommand": {
"required": [
"accountCode",
"administrationId",
"purchaseDate",
"purchaseOrderNumber"
],
"type": "object",
"properties": {
"purchaseOrderNumber": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"purchaseDate": {
"minLength": 1,
"type": "string",
"format": "date-time"
},
"accountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"customerReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"warehouseCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"isDropShipment": {
"type": "boolean"
},
"taxExclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalTaxAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"taxInclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"externalCreatorUserFullName": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalCreationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalLastModifierUserFullName": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalId": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderLinePublicAPIEditDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"CreateTaxCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/TaxCodeType"
},
"calculationMode": {
"$ref": "#/components/schemas/TaxCodeCalculationMode"
},
"isIcp": {
"type": "boolean"
},
"isCharged": {
"type": "boolean"
},
"percentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCodePercentagePublicAPIDto"
},
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"chargedLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"isIntrastatEntryAllowed": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CreateTaxScenarioCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"fiscalYear": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxScenarioType": {
"$ref": "#/components/schemas/TaxScenarioType"
},
"taxScenarioLocation": {
"$ref": "#/components/schemas/TaxScenarioLocation"
},
"taxOnInvoice": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CurrencyPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"priceNumberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"CurrencyPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CustomFieldDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CustomFieldLevel": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (FinancialTransaction), 1 (FinancialTransactionLine)",
"format": "int32",
"x-enumNames": [
"FinancialTransaction",
"FinancialTransactionLine"
]
},
"CustomFieldLookupValueDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
},
"localizedNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocalizedTextDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"CustomFieldPublicAPIDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"localizedNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocalizedTextDto"
},
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"isRequired": {
"type": "boolean"
},
"isEnabled": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/CustomFieldType"
},
"defaultValue": {
"type": "string",
"nullable": true
},
"maxLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"min": {
"type": "number",
"format": "double",
"nullable": true
},
"max": {
"type": "number",
"format": "double",
"nullable": true
},
"precision": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lookupValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldLookupValueDto"
},
"nullable": true
},
"ledgerAccountSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountLineCustomFieldSettingsDto"
},
"nullable": true
},
"customFieldLevel": {
"$ref": "#/components/schemas/CustomFieldLevel"
}
},
"additionalProperties": false
},
"CustomFieldType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "0 (Text), 1 (Numeric), 2 (Percentage), 3 (Lookup)",
"format": "int32",
"x-enumNames": [
"Text",
"Numeric",
"Percentage",
"Lookup"
]
},
"DeleteAIRApiModelInput": {
"required": [
"modelId"
],
"type": "object",
"properties": {
"modelId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"DeleteAccountByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
}
},
"additionalProperties": false
},
"DeleteAccountByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
}
},
"additionalProperties": false
},
"DeleteAllocationCodeByCodeCommand": {
"required": [
"administrationId",
"allocationAxleCode",
"code",
"ledgerAccountCode"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 20,
"minLength": 1,
"type": "string"
},
"allocationAxleCode": {
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"ledgerAccountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteAllocationCodeByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCommitmentByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCommitmentByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCostCentreByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCostCentreByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCostUnitByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCostUnitByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCountryByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 10,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCountryByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCurrencyByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteCurrencyByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteEmployeeByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteEmployeeByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteFiscalPeriodByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteFiscalPeriodByFiscalYearCommand": {
"required": [
"administrationId",
"fiscalYear",
"period"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"fiscalYear": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"period": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DeleteInboxDocumentCommand": {
"required": [
"administrationId",
"inboxDocumentId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"inboxDocumentId": {
"type": "integer",
"format": "int32"
},
"isPermanentDelete": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DeleteLedgerAccountByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteLedgerAccountByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeletePaymentConditionByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeletePaymentConditionByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProductByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProductByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProjectByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProjectByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProjectItemByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProjectItemByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProjectStageByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteProjectStageByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeletePurchaseOrderByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeletePurchaseOrderCommand": {
"required": [
"administrationId",
"purchaseOrderNumber"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"purchaseOrderNumber": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteTaxCodeByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteTaxCodeByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteTaxScenarioByCodeCommand": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteTaxScenarioByExternalIdCommand": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"EmployeePublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"costCentreCode": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"EmployeePublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeePublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ErrorInfo": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"details": {
"type": "string",
"nullable": true
},
"validationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorInfo"
},
"nullable": true
}
},
"additionalProperties": false
},
"ExternalPurchaseOrderLineType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Product), 1 (Text)",
"format": "int32",
"x-enumNames": [
"Product",
"Text"
]
},
"FieldWithCorrectValue": {
"required": [
"fieldName"
],
"type": "object",
"properties": {
"fieldName": {
"minLength": 1,
"type": "string",
"description": "Field name."
},
"correctValue": {
"type": "string",
"description": "Correct value.",
"nullable": true
},
"correctValueGroup": {
"type": "string",
"description": "Semicolon separated int list of groups. To be used with address fields.\r\nIf there are two addresses in the document, the first StreetName should be group id 1, the second should be group id 2, for example.\r\nLeave empty if there are no groups.",
"nullable": true
}
},
"additionalProperties": false
},
"FinancialTransactionAIRResultDto": {
"type": "object",
"properties": {
"airDocumentId": {
"type": "string",
"nullable": true
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"invoiceNumberConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invoiceDateConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dueDateConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"totalAmountExclTax": {
"type": "number",
"format": "double",
"nullable": true
},
"totalAmountExclTaxConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"totalAmountInclTax": {
"type": "number",
"format": "double",
"nullable": true
},
"totalAmountInclTaxConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"taxLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRResultTaxLineDto"
},
"nullable": true
},
"matchedAccount": {
"$ref": "#/components/schemas/AIRResultMatchedAccountDto"
},
"vatNumber": {
"type": "string",
"nullable": true
},
"vatNumberConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"coCNumber": {
"type": "string",
"nullable": true
},
"coCNumberConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"customerIdentifier": {
"type": "string",
"nullable": true
},
"customerIdentifierConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"iban": {
"type": "string",
"nullable": true
},
"ibanConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"isReceipt": {
"type": "boolean"
},
"isCreditInvoice": {
"type": "boolean"
},
"yourReference": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"yourReferenceConfidences": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"yourOrderNumber": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"yourOrderNumberConfidences": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"contractNumber": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"contractNumberConfidences": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"structuredPaymentReference": {
"type": "string",
"nullable": true
},
"structuredPaymentReferenceConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"isValidated": {
"type": "boolean"
},
"validationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"currency": {
"type": "string",
"nullable": true
},
"currencyConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"lineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRResultLineItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"FinancialTransactionAccountMatchType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
],
"type": "integer",
"description": "0 (CoCNumber), 1 (VatNumber), 2 (IBAN), 3 (CustomerCode), 4 (JournalDefault), 5 (ReceiptDefault), 6 (PostalCode), 7 (TelephoneNumber), 8 (CustomerCodeAndPostalCode), 9 (CustomerCodeAndEmail), 10 (PostalCodeAndEmail), 11 (AutomationRule), 12 (CoCNumberAndPostalCode), 13 (NameAndPostalCode), 14 (Name), 15 (NameAndPostalCodeAndStreet)",
"format": "int32",
"x-enumNames": [
"CoCNumber",
"VatNumber",
"IBAN",
"CustomerCode",
"JournalDefault",
"ReceiptDefault",
"PostalCode",
"TelephoneNumber",
"CustomerCodeAndPostalCode",
"CustomerCodeAndEmail",
"PostalCodeAndEmail",
"AutomationRule",
"CoCNumberAndPostalCode",
"NameAndPostalCode",
"Name",
"NameAndPostalCodeAndStreet"
]
},
"FinancialTransactionAppliedAutomationRuleDto": {
"type": "object",
"properties": {
"financialTransactionAutomationRuleId": {
"type": "integer",
"format": "int32"
},
"financialTransactionAutomationRuleDescription": {
"type": "string",
"nullable": true
},
"financialTransactionAutomationRuleActionType": {
"$ref": "#/components/schemas/FinancialTransactionAutomationRuleActionType"
}
},
"additionalProperties": false
},
"FinancialTransactionAttachmentDto": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64"
},
"storageId": {
"type": "string",
"format": "uuid"
},
"attachmentKind": {
"$ref": "#/components/schemas/AttachmentKind"
},
"creatorUserFullName": {
"type": "string",
"nullable": true
},
"creatorUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"creationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"downloadUrl": {
"type": "string",
"description": "Url to download the attachment. The url is valid for 1 hour.",
"nullable": true
}
},
"additionalProperties": false
},
"FinancialTransactionAuthorizationProcuratorDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"level": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userId": {
"type": "integer",
"format": "int64"
},
"userUserName": {
"type": "string",
"nullable": true
},
"userFullName": {
"type": "string",
"nullable": true
},
"isOptional": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationProcuratorStatus"
},
"statusChangeTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"forwaredToProcuratorId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"forwaredToProcuratorUserFullName": {
"type": "string",
"nullable": true
},
"statusChangeImpersonatorUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"statusChangeImpersonatorUserUserName": {
"type": "string",
"nullable": true
},
"statusChangeImpersonatorUserFullName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FinancialTransactionAuthorizationProcuratorLogDto": {
"type": "object",
"properties": {
"procuratorId": {
"type": "integer",
"format": "int32"
},
"oldStatus": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationProcuratorStatus"
},
"newStatus": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationProcuratorStatus"
},
"remarkId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"impersonatorUserId": {
"type": "integer",
"description": "The user id of the impersonator user that executed the status change.",
"format": "int64",
"nullable": true
},
"impersonatorUserUserName": {
"type": "string",
"nullable": true
},
"impersonatorUserFullName": {
"type": "string",
"nullable": true
},
"creationTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"FinancialTransactionAuthorizationProcuratorStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "0 (Pending), 1 (Approved), 2 (Rejected), 3 (OnHold), 4 (Forwarded), 5 (NotApplicable), 6 (NotAuthorized)",
"format": "int32",
"x-enumNames": [
"Pending",
"Approved",
"Rejected",
"OnHold",
"Forwarded",
"NotApplicable",
"NotAuthorized"
]
},
"FinancialTransactionAuthorizationStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "0 (NotApplicable), 1 (Authorized), 2 (RejectedNotHandled), 3 (RejectedHandled), 4 (Pending), 5 (AwaitingExport), 6 (AwaitingApproval)",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"Authorized",
"RejectedNotHandled",
"RejectedHandled",
"Pending",
"AwaitingExport",
"AwaitingApproval"
]
},
"FinancialTransactionAuthorizationStatusLogDto": {
"type": "object",
"properties": {
"oldStatus": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationStatus"
},
"newStatus": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationStatus"
},
"creationTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"FinancialTransactionAutomationRuleActionType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (ApproveProposal), 1 (AssignAccount), 2 (AssignProposalStrategy)",
"format": "int32",
"x-enumNames": [
"ApproveProposal",
"AssignAccount",
"AssignProposalStrategy"
]
},
"FinancialTransactionDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"journalId": {
"type": "integer",
"format": "int32"
},
"journalCode": {
"type": "string",
"nullable": true
},
"journalName": {
"type": "string",
"nullable": true
},
"journalType": {
"$ref": "#/components/schemas/JournalType"
},
"transactionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fiscalDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"fiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"paymentReference": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"currencyExternalId": {
"type": "string",
"nullable": true
},
"accountCode": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"accountExternalId": {
"type": "string",
"nullable": true
},
"paymentConditionCode": {
"type": "string",
"nullable": true
},
"paymentConditionName": {
"type": "string",
"nullable": true
},
"paymentConditionExternalId": {
"type": "string",
"nullable": true
},
"taxScenarioCode": {
"type": "string",
"nullable": true
},
"taxScenarioName": {
"type": "string",
"nullable": true
},
"taxScenarioExternalId": {
"type": "string",
"nullable": true
},
"projectCode": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"projectExternalId": {
"type": "string",
"nullable": true
},
"costCentreCode": {
"type": "string",
"nullable": true
},
"costCentreName": {
"type": "string",
"nullable": true
},
"costCentreExternalId": {
"type": "string",
"nullable": true
},
"costUnitCode": {
"type": "string",
"nullable": true
},
"costUnitName": {
"type": "string",
"nullable": true
},
"costUnitExternalId": {
"type": "string",
"nullable": true
},
"warehouseCode": {
"type": "string",
"nullable": true
},
"warehouseDescription": {
"type": "string",
"nullable": true
},
"warehouseExternalId": {
"type": "string",
"nullable": true
},
"isDirectPurchaseInvoice": {
"type": "boolean"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionLineDto"
},
"nullable": true
},
"taxExclusiveAmount": {
"type": "number",
"format": "double"
},
"totalTaxAmount": {
"type": "number",
"format": "double"
},
"taxInclusiveAmount": {
"type": "number",
"format": "double"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionAttachmentDto"
},
"nullable": true
},
"isValid": {
"type": "boolean"
},
"isApproved": {
"type": "boolean"
},
"isDraft": {
"type": "boolean"
},
"approvalTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"approvalUserFullName": {
"type": "string",
"nullable": true
},
"approvalAutomationRuleDescription": {
"type": "string",
"nullable": true
},
"exportStatus": {
"$ref": "#/components/schemas/FinancialTransactionExportStatus"
},
"exportErrorMessage": {
"type": "string",
"nullable": true
},
"exportTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exportUserFullName": {
"type": "string",
"nullable": true
},
"externalTransactionNumber": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"creatorUserFullName": {
"type": "string",
"nullable": true
},
"lastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastModifierUserFullName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/FinancialTransactionType"
},
"authorizationSchemeName": {
"type": "string",
"nullable": true
},
"authorizationSchemeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"currentAuthorizationLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"authorizationStatus": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationStatus"
},
"authorizationStatusLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationStatusLogDto"
},
"nullable": true
},
"authorizationProcurators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationProcuratorDto"
},
"nullable": true
},
"authorizationProcuratorLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationProcuratorLogDto"
},
"nullable": true
},
"setPayableStatus": {
"$ref": "#/components/schemas/FinancialTransactionSetPayableStatus"
},
"setPayableTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"setPayableUserFullName": {
"type": "string",
"nullable": true
},
"usedProposalStrategy": {
"$ref": "#/components/schemas/FinancialTransactionProposalStrategy"
},
"gAccountAmountCalculationMode": {
"$ref": "#/components/schemas/FinancialTransactionGAccountAmountCalculationMode"
},
"gAccountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"spreadStartFiscalYear": {
"type": "string",
"nullable": true
},
"spreadStartFiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"spreadEndFiscalYear": {
"type": "string",
"nullable": true
},
"spreadEndFiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"spreadLedgerAccountCode": {
"type": "string",
"nullable": true
},
"inboxDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"inboxDocumentReceivedTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"inboxDocumentOrigin": {
"$ref": "#/components/schemas/InboxDocumentOrigin"
},
"inboxDocumentSubject": {
"type": "string",
"nullable": true
},
"inboxDocumentSenderName": {
"type": "string",
"nullable": true
},
"inboxDocumentSenderId": {
"type": "string",
"nullable": true
},
"inboxDocumentChannelName": {
"type": "string",
"nullable": true
},
"inboxDocumentRemarks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentRemarkDto"
},
"nullable": true
},
"includeInInternalPaymentBatch": {
"type": "boolean"
},
"notPaidAmount": {
"type": "number",
"format": "double"
},
"includeInPaymentBatch": {
"type": "boolean",
"nullable": true
},
"isProposalChanged": {
"type": "boolean",
"nullable": true
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionPaymentDto"
},
"nullable": true
},
"purchaseInvoiceAssessmentResult": {
"$ref": "#/components/schemas/FinancialTransactionPurchaseInvoiceAssessmentResult"
},
"recognitionConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"appliedAutomationRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionAppliedAutomationRuleDto"
},
"nullable": true
},
"remarks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionRemarkDto"
},
"nullable": true
},
"airResult": {
"$ref": "#/components/schemas/FinancialTransactionAIRResultDto"
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldDto"
},
"nullable": true
},
"extractedCostType": {
"$ref": "#/components/schemas/CostType"
},
"extractedDocumentSummary": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FinancialTransactionExportStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "0 (Queued), 1 (Failed), 2 (Succeeded), 3 (Pending), 4 (AwaitingAuthorization), 5 (AwaitingApproval), 6 (NonApplicable)",
"format": "int32",
"x-enumNames": [
"Queued",
"Failed",
"Succeeded",
"Pending",
"AwaitingAuthorization",
"AwaitingApproval",
"NonApplicable"
]
},
"FinancialTransactionExtractedCustomRecognitionLineFieldDto": {
"type": "object",
"properties": {
"fieldValue": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"customRecognitionFieldId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"FinancialTransactionGAccountAmountCalculationMode": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (NotApplicable), 1 (Percentage), 2 (FixedAmount)",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"Percentage",
"FixedAmount"
]
},
"FinancialTransactionLineDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"transactionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fiscalDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"spreadStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"spreadEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"spreadNumberOfPeriods": {
"type": "integer",
"format": "int32",
"nullable": true
},
"spreadStartFiscalYear": {
"type": "string",
"nullable": true
},
"spreadStartFiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"spreadEndFiscalYear": {
"type": "string",
"nullable": true
},
"spreadEndFiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"spreadLedgerAccountCode": {
"type": "string",
"nullable": true
},
"spreadLedgerAccountName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"ledgerAccountName": {
"type": "string",
"nullable": true
},
"ledgerAccountExternalId": {
"type": "string",
"nullable": true
},
"costCentreCode": {
"type": "string",
"nullable": true
},
"costCentreName": {
"type": "string",
"nullable": true
},
"costCentreExternalId": {
"type": "string",
"nullable": true
},
"costUnitCode": {
"type": "string",
"nullable": true
},
"costUnitName": {
"type": "string",
"nullable": true
},
"costUnitExternalId": {
"type": "string",
"nullable": true
},
"projectCode": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"projectExternalId": {
"type": "string",
"nullable": true
},
"projectItemCode": {
"type": "string",
"nullable": true
},
"projectItemName": {
"type": "string",
"nullable": true
},
"projectItemExternalId": {
"type": "string",
"nullable": true
},
"projectStageCode": {
"type": "string",
"nullable": true
},
"projectStageName": {
"type": "string",
"nullable": true
},
"projectStageExternalId": {
"type": "string",
"nullable": true
},
"chargeProjectCosts": {
"type": "boolean"
},
"productCode": {
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"productName": {
"type": "string",
"nullable": true
},
"productExternalId": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeExternalId": {
"type": "string",
"nullable": true
},
"afasAxle1AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle1AllocationCodeName": {
"type": "string",
"nullable": true
},
"afasAxle1AllocationCodeExternalId": {
"type": "string",
"nullable": true
},
"afasAxle2AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle2AllocationCodeName": {
"type": "string",
"nullable": true
},
"afasAxle2AllocationCodeExternalId": {
"type": "string",
"nullable": true
},
"afasAxle3AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle3AllocationCodeName": {
"type": "string",
"nullable": true
},
"afasAxle3AllocationCodeExternalId": {
"type": "string",
"nullable": true
},
"afasAxle4AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle4AllocationCodeName": {
"type": "string",
"nullable": true
},
"afasAxle4AllocationCodeExternalId": {
"type": "string",
"nullable": true
},
"afasAxle5AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle5AllocationCodeName": {
"type": "string",
"nullable": true
},
"afasAxle5AllocationCodeExternalId": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"unitPrice": {
"type": "number",
"description": "Gross price per unit (without discount, tax code taken into account)",
"format": "double",
"nullable": true
},
"discountPercentage": {
"type": "number",
"description": "Discount percentage",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"description": "Net price per unit (tax code taken into account, equals to UnitPrice * (1 - DiscountPercentage))",
"format": "double",
"nullable": true
},
"pricePer": {
"type": "number",
"format": "double",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"taxAmount": {
"type": "number",
"format": "double"
},
"intraCommunityPerformanceType": {
"$ref": "#/components/schemas/IntraCommunityPerformanceType"
},
"intraCommunityPerformanceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"taxCodeName": {
"type": "string",
"nullable": true
},
"taxCodeExternalId": {
"type": "string",
"nullable": true
},
"taxRate": {
"type": "number",
"format": "double"
},
"isTaxReverseCharged": {
"type": "boolean"
},
"taxNonDeductiblePercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"privateUsePercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"externalPurchaseOrderLineExternalId": {
"type": "string",
"nullable": true
},
"externalPurchaseOrderNumber": {
"type": "string",
"nullable": true
},
"externalPurchaseOrderLineNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"commitmentCode": {
"type": "string",
"nullable": true
},
"commitmentDescription": {
"type": "string",
"nullable": true
},
"commitmentExternalId": {
"type": "string",
"nullable": true
},
"isCommitmentHandled": {
"type": "boolean"
},
"purchaseInvoiceLineQuantityAssessmentResult": {
"$ref": "#/components/schemas/FinancialTransactionPurchaseInvoiceLineAssessmentResult"
},
"purchaseInvoiceLinePriceAssessmentResult": {
"$ref": "#/components/schemas/FinancialTransactionPurchaseInvoiceLineAssessmentResult"
},
"purchaseInvoiceLineAssessmentResult": {
"$ref": "#/components/schemas/FinancialTransactionPurchaseInvoiceLineAssessmentResult"
},
"purchaseInvoiceLineAssessmentSource": {
"$ref": "#/components/schemas/FinancialTransactionPurchaseInvoiceLineAssessmentSource"
},
"goodsReceiptLineExternalId": {
"type": "string",
"nullable": true
},
"goodsReceiptNumber": {
"type": "string",
"nullable": true
},
"goodsReceiptLineNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldDto"
},
"nullable": true
},
"intrastatCountryCode": {
"type": "string",
"nullable": true
},
"intrastatCountryDisplayName": {
"type": "string",
"nullable": true
},
"intrastatRegionCode": {
"type": "string",
"nullable": true
},
"intrastatRegionDisplayName": {
"type": "string",
"nullable": true
},
"intrastatOriginCountryCode": {
"type": "string",
"nullable": true
},
"intrastatOriginCountryDisplayName": {
"type": "string",
"nullable": true
},
"intrastatProductCode": {
"type": "string",
"nullable": true
},
"intrastatProductDisplayName": {
"type": "string",
"nullable": true
},
"intrastatTransactionCode": {
"type": "string",
"nullable": true
},
"intrastatTransactionDisplayName": {
"type": "string",
"nullable": true
},
"intrastatTransportMethodCode": {
"type": "string",
"nullable": true
},
"intrastatTransportMethodDisplayName": {
"type": "string",
"nullable": true
},
"intrastatDeliveryTermCode": {
"type": "string",
"nullable": true
},
"intrastatDeliveryTermDisplayName": {
"type": "string",
"nullable": true
},
"intrastatNetWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"intrastatQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"intrastatValue": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"FinancialTransactionListDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"journalId": {
"type": "integer",
"format": "int32"
},
"journalCode": {
"type": "string",
"nullable": true
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"transactionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"taxInclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"taxExclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalTaxAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"accountCode": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"lastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exportErrorMessage": {
"type": "string",
"nullable": true
},
"setPayableErrorMessage": {
"type": "string",
"nullable": true
},
"authorizationStatus": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationStatus"
},
"exportStatus": {
"$ref": "#/components/schemas/FinancialTransactionExportStatus"
},
"externalTransactionNumber": {
"type": "string",
"description": "Transaction number in the external accounting system.",
"nullable": true
},
"journalType": {
"$ref": "#/components/schemas/JournalType"
},
"description": {
"type": "string",
"nullable": true
},
"descriptionReplacedVariables": {
"type": "string",
"nullable": true
},
"paymentReference": {
"type": "string",
"nullable": true
},
"paymentReferenceReplacedVariables": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"paymentConditionCode": {
"type": "string",
"nullable": true
},
"taxScenarioCode": {
"type": "string",
"nullable": true
},
"costCentreCode": {
"type": "string",
"nullable": true
},
"costUnitCode": {
"type": "string",
"nullable": true
},
"projectCode": {
"type": "string",
"nullable": true
},
"warehouseCode": {
"type": "string",
"nullable": true
},
"isDirectPurchaseInvoice": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/FinancialTransactionType"
},
"includeInInternalPaymentBatch": {
"type": "boolean",
"description": "Bool indicating if the financial transaction must be included in a Zenvoices payment batch."
},
"purchaseInvoiceAssessmentResult": {
"$ref": "#/components/schemas/FinancialTransactionPurchaseInvoiceAssessmentResult"
},
"recognitionConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"fiscalDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"isApproved": {
"type": "boolean",
"description": "Bool indicating if the booking proposal is approved."
},
"isDraft": {
"type": "boolean",
"description": "Bool indicating that the proposal is provisional. \r\nCan only be True if IsApproved is False."
},
"inboxDocumentReceivedTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"inboxDocumentSenderName": {
"type": "string",
"nullable": true
},
"inboxDocumentSenderId": {
"type": "string",
"nullable": true
},
"inboxDocumentOrigin": {
"$ref": "#/components/schemas/InboxDocumentOrigin"
},
"approvalTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"approvalUserFullName": {
"type": "string",
"nullable": true
},
"isApprovedByAutomationRule": {
"type": "boolean"
},
"exportTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"notPaidAmount": {
"type": "number",
"format": "double"
},
"importAttachmentFileName": {
"type": "string",
"nullable": true
},
"isImportedByAIR": {
"type": "boolean"
},
"isProposalChanged": {
"type": "boolean",
"nullable": true
},
"accountMatchType": {
"$ref": "#/components/schemas/FinancialTransactionAccountMatchType"
},
"lineLedgerAccountCodes": {
"type": "string",
"nullable": true
},
"lineCostCentreCodes": {
"type": "string",
"description": "Comma separated string of the unique line cost centre codes.",
"nullable": true
},
"lineCostUnitCodes": {
"type": "string",
"description": "Comma separated string of the unique line cost unit codes.",
"nullable": true
},
"lineProjectCodes": {
"type": "string",
"description": "Comma separated string of the unique line project codes.",
"nullable": true
},
"lineProductCodes": {
"type": "string",
"description": "Comma separated string of the unique line product codes.",
"nullable": true
},
"lineEmployeeCodes": {
"type": "string",
"description": "Comma separated string of the unique line employee codes.",
"nullable": true
},
"usedProposalStrategy": {
"$ref": "#/components/schemas/FinancialTransactionProposalStrategy"
}
},
"additionalProperties": false
},
"FinancialTransactionListDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionListDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"FinancialTransactionPaymentDto": {
"type": "object",
"properties": {
"paymentType": {
"$ref": "#/components/schemas/FinancialTransactionPaymentType"
},
"description": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"paymentDate": {
"type": "string",
"format": "date-time"
},
"paymentBatchPaymentPaymentBatchId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentBatchPaymentPaymentBatchDescription": {
"type": "string",
"nullable": true
},
"paymentBatchPaymentPaymentBatchBankAccountIBAN": {
"type": "string",
"nullable": true
},
"paymentBatchPaymentPaymentBatchBankAccountDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FinancialTransactionPaymentType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Manual), 1 (Batch)",
"format": "int32",
"x-enumNames": [
"Manual",
"Batch"
]
},
"FinancialTransactionProposalStrategy": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "0 (MasterData), 1 (LastFinancialTransactionHeaderLevel), 2 (FinancialTransactionTemplate), 3 (Custom), 4 (LastFinancialTransactionLineLevel)",
"format": "int32",
"x-enumNames": [
"MasterData",
"LastFinancialTransactionHeaderLevel",
"FinancialTransactionTemplate",
"Custom",
"LastFinancialTransactionLineLevel"
]
},
"FinancialTransactionPurchaseInvoiceAssessmentResult": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (CorrectAutomatically), 1 (CorrectManually), 2 (Incorrect)",
"format": "int32",
"x-enumNames": [
"CorrectAutomatically",
"CorrectManually",
"Incorrect"
]
},
"FinancialTransactionPurchaseInvoiceLineAssessmentResult": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Correct), 1 (Incorrect)",
"format": "int32",
"x-enumNames": [
"Correct",
"Incorrect"
]
},
"FinancialTransactionPurchaseInvoiceLineAssessmentSource": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "0 (PurchaseOrder), 1 (Rule), 2 (Manual), 3 (Commitment)",
"format": "int32",
"x-enumNames": [
"PurchaseOrder",
"Rule",
"Manual",
"Commitment"
]
},
"FinancialTransactionRemarkDto": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"creatorUserUserName": {
"type": "string",
"nullable": true
},
"creatorUserFullName": {
"type": "string",
"nullable": true
},
"impersonatorUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"impersonatorUserUserName": {
"type": "string",
"nullable": true
},
"impersonatorUserFullName": {
"type": "string",
"nullable": true
},
"origin": {
"$ref": "#/components/schemas/RemarkOrigin"
}
},
"additionalProperties": false
},
"FinancialTransactionSetPayableStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"description": "0 (NotApplicable), 1 (AwaitingAuthorization), 2 (Queued), 3 (FailedNotHandled), 4 (FailedHandled), 5 (Succeeded), 6 (Pending)",
"format": "int32",
"x-enumNames": [
"NotApplicable",
"AwaitingAuthorization",
"Queued",
"FailedNotHandled",
"FailedHandled",
"Succeeded",
"Pending"
]
},
"FinancialTransactionType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (JournalEntry), 1 (ArchiveOnly), 2 (PurchaseInvoice)",
"format": "int32",
"x-enumNames": [
"JournalEntry",
"ArchiveOnly",
"PurchaseInvoice"
]
},
"FiscalPeriodPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"period": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"FiscalPeriodPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FiscalPeriodPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetAccountByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
}
},
"additionalProperties": false
},
"GetAccountByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
}
},
"additionalProperties": false
},
"GetAccountsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"filters": {
"$ref": "#/components/schemas/ListAccountsInputFilters"
}
},
"additionalProperties": false
},
"GetAdministrationDetailsOutput": {
"type": "object",
"properties": {
"administration": {
"$ref": "#/components/schemas/AdministrationDetailsDto"
}
},
"additionalProperties": false
},
"GetAllSendAttemptsOutput": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"webhookEventId": {
"type": "string",
"description": "Guid of the webhook event",
"format": "uuid"
},
"webhookName": {
"type": "string",
"description": "Webhook unique name",
"nullable": true
},
"data": {
"type": "string",
"description": "Webhook data as JSON string.",
"nullable": true
},
"response": {
"type": "string",
"description": "Webhook response content that webhook endpoint send back",
"nullable": true
},
"responseStatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"creationTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"GetAllSendAttemptsOutputPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllSendAttemptsOutput"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetAllocationCodeByCodeQuery": {
"required": [
"administrationId",
"allocationAxleCode",
"code",
"ledgerAccountCode"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 20,
"minLength": 1,
"type": "string"
},
"allocationAxleCode": {
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"ledgerAccountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetAllocationCodeByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetAllocationCodesListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetCommitmentByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCommitmentByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCommitmentsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetCostCentresByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCostCentresByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCostCentresListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetCostUnitByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCostUnitByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCostUnitsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetCountriesListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetCountryByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 10,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCountryByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCurrenciesListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetCurrencyByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCurrencyByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetCustomFieldDetailsQuery": {
"required": [
"administrationId",
"name"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"customFieldLevel": {
"$ref": "#/components/schemas/CustomFieldLevel"
}
},
"additionalProperties": false
},
"GetEmployeeByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetEmployeeByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetEmployeesListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetFinancialTransactionDetailsOutput": {
"type": "object",
"properties": {
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransactionDto"
}
},
"additionalProperties": false
},
"GetFiscalPeriodByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetFiscalPeriodByFiscalYearQuery": {
"required": [
"administrationId",
"fiscalYear",
"period"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"fiscalYear": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"period": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetFiscalPeriodsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetInboxDocumentDetailsQuery": {
"required": [
"administrationId",
"inboxDocumentId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"inboxDocumentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetInboxDocumentsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"filters": {
"$ref": "#/components/schemas/InboxDocumentListFilters"
}
},
"additionalProperties": false
},
"GetLedgerAccountByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetLedgerAccountByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetLedgerAccountsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetOperationResultOutput": {
"type": "object",
"properties": {
"operation": {
"$ref": "#/components/schemas/AIRApiOperationDto"
},
"result": {
"$ref": "#/components/schemas/AIRApiResult"
}
},
"additionalProperties": false
},
"GetPaymentConditionByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetPaymentConditionByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetPaymentConditionsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetProductByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProductByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProductsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetProjectByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProjectByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProjectItemByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProjectItemByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProjectItemsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetProjectStageByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProjectStageByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetProjectStagesListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetProjectsListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetPurchaseOrderByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetPurchaseOrderQuery": {
"required": [
"administrationId",
"purchaseOrderNumber"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"purchaseOrderNumber": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetPurchaseOrdersListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetTaxCodeByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetTaxCodeByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetTaxCodesListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetTaxScenarioByCodeQuery": {
"required": [
"administrationId",
"code"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"fiscalYear": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GetTaxScenarioByExternalIdQuery": {
"required": [
"administrationId",
"externalId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"GetTaxScenariosListQuery": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetUserDetailsOutput": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserDto"
}
},
"additionalProperties": false
},
"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": "100 (Continue), 101 (SwitchingProtocols), 102 (Processing), 103 (EarlyHints), 200 (OK), 201 (Created), 202 (Accepted), 203 (NonAuthoritativeInformation), 204 (NoContent), 205 (ResetContent), 206 (PartialContent), 207 (MultiStatus), 208 (AlreadyReported), 226 (IMUsed), 300 (MultipleChoices), 301 (MovedPermanently), 302 (Found), 303 (SeeOther), 304 (NotModified), 305 (UseProxy), 306 (Unused), 307 (RedirectKeepVerb), 308 (PermanentRedirect), 400 (BadRequest), 401 (Unauthorized), 402 (PaymentRequired), 403 (Forbidden), 404 (NotFound), 405 (MethodNotAllowed), 406 (NotAcceptable), 407 (ProxyAuthenticationRequired), 408 (RequestTimeout), 409 (Conflict), 410 (Gone), 411 (LengthRequired), 412 (PreconditionFailed), 413 (RequestEntityTooLarge), 414 (RequestUriTooLong), 415 (UnsupportedMediaType), 416 (RequestedRangeNotSatisfiable), 417 (ExpectationFailed), 421 (MisdirectedRequest), 422 (UnprocessableEntity), 423 (Locked), 424 (FailedDependency), 426 (UpgradeRequired), 428 (PreconditionRequired), 429 (TooManyRequests), 431 (RequestHeaderFieldsTooLarge), 451 (UnavailableForLegalReasons), 500 (InternalServerError), 501 (NotImplemented), 502 (BadGateway), 503 (ServiceUnavailable), 504 (GatewayTimeout), 505 (HttpVersionNotSupported), 506 (VariantAlsoNegotiates), 507 (InsufficientStorage), 508 (LoopDetected), 510 (NotExtended), 511 (NetworkAuthenticationRequired)",
"format": "int32",
"x-enumNames": [
"Continue",
"SwitchingProtocols",
"Processing",
"EarlyHints",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultiStatus",
"AlreadyReported",
"IMUsed",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"PermanentRedirect",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"MisdirectedRequest",
"UnprocessableEntity",
"UnprocessableContent",
"Locked",
"FailedDependency",
"UpgradeRequired",
"PreconditionRequired",
"TooManyRequests",
"RequestHeaderFieldsTooLarge",
"UnavailableForLegalReasons",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported",
"VariantAlsoNegotiates",
"InsufficientStorage",
"LoopDetected",
"NotExtended",
"NetworkAuthenticationRequired"
]
},
"InboxDocumentAuthorizationStatus": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "0 (New), 1 (Imported), 2 (Deleted), 3 (Spam), 4 (PermanentlyDeleted)",
"format": "int32",
"x-enumNames": [
"New",
"Imported",
"Deleted",
"Spam",
"PermanentlyDeleted"
]
},
"InboxDocumentAuthorizationStatusChangeDto": {
"type": "object",
"properties": {
"oldStatus": {
"$ref": "#/components/schemas/InboxDocumentAuthorizationStatus"
},
"newStatus": {
"$ref": "#/components/schemas/InboxDocumentAuthorizationStatus"
},
"statusChangeTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"InboxDocumentDestination": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (None), 1 (Journal), 2 (DocumentArchive)",
"format": "int32",
"x-enumNames": [
"None",
"Journal",
"DocumentArchive"
]
},
"InboxDocumentDetailsPublicAPIDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"senderName": {
"type": "string",
"nullable": true
},
"senderId": {
"type": "string",
"nullable": true
},
"recipientId": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"destination": {
"$ref": "#/components/schemas/InboxDocumentDestination"
},
"designatedArchiveDocumentCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"designatedJournalId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"receivedTime": {
"type": "string",
"format": "date-time"
},
"origin": {
"$ref": "#/components/schemas/InboxDocumentOrigin"
},
"manualUploadUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"manualUploadUserFullName": {
"type": "string",
"nullable": true
},
"authorizationStatus": {
"$ref": "#/components/schemas/InboxDocumentAuthorizationStatus"
},
"authorizationStatusTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"authorizationStatusUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"authorizationStatusUserFullName": {
"type": "string",
"nullable": true
},
"importStatus": {
"$ref": "#/components/schemas/InboxDocumentImportStatus"
},
"importStatusTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"importErrorCustomMessage": {
"type": "string",
"nullable": true
},
"importErrorKind": {
"$ref": "#/components/schemas/InboxDocumentImportErrorKind"
},
"exportStatus": {
"$ref": "#/components/schemas/InboxDocumentExportStatus"
},
"exportErrorMessage": {
"type": "string",
"nullable": true
},
"exportTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recognitionConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"isSplitRequired": {
"type": "boolean"
},
"channelId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"channelName": {
"type": "string",
"nullable": true
},
"categoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"categoryName": {
"type": "string",
"nullable": true
},
"authorizationStatusChanges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentAuthorizationStatusChangeDto"
},
"nullable": true
},
"permanentlyDeleteTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"importRetryCount": {
"type": "integer",
"format": "int32"
},
"documentType": {
"$ref": "#/components/schemas/InboxDocumentType"
},
"exportLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentExportLogDto"
},
"nullable": true
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"InboxDocumentExportLogDto": {
"type": "object",
"properties": {
"exportTime": {
"type": "string",
"format": "date-time"
},
"status": {
"$ref": "#/components/schemas/InboxDocumentExportStatus"
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InboxDocumentExportStatus": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "0 (Failed), 1 (Succeeded), 2 (Queued), 3 (AwaitingManualValidation)",
"format": "int32",
"x-enumNames": [
"Failed",
"Succeeded",
"Queued",
"AwaitingManualValidation"
]
},
"InboxDocumentImportErrorKind": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (NotSupportedFormat), 1 (Custom)",
"format": "int32",
"x-enumNames": [
"NotSupportedFormat",
"Custom"
]
},
"InboxDocumentImportStatus": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Failed), 1 (Succeeded)",
"format": "int32",
"x-enumNames": [
"Failed",
"Succeeded"
]
},
"InboxDocumentListFilters": {
"type": "object",
"properties": {
"senderName": {
"type": "string",
"nullable": true
},
"senderId": {
"type": "string",
"nullable": true
},
"recipientId": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"destination": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentDestination"
},
"nullable": true
},
"designatedArchiveDocumentCategoryIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"designatedJournalIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"receivedTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"origin": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentOrigin"
},
"nullable": true
},
"authorizationStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentAuthorizationStatus"
},
"nullable": true
},
"manualUploadUserIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"importStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentImportStatus"
},
"nullable": true
},
"importStatusTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"importStatusTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exportStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentExportStatus"
},
"nullable": true
},
"exportTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exportTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recognitionConfidenceFrom": {
"type": "number",
"format": "double",
"nullable": true
},
"recognitionConfidenceTo": {
"type": "number",
"format": "double",
"nullable": true
},
"isSplitRequired": {
"type": "boolean",
"nullable": true
},
"channelIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"categoryIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"InboxDocumentListPublicAPIDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"senderName": {
"type": "string",
"nullable": true
},
"senderId": {
"type": "string",
"nullable": true
},
"recipientId": {
"type": "string",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"destination": {
"$ref": "#/components/schemas/InboxDocumentDestination"
},
"designatedArchiveDocumentCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"designatedJournalId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"receivedTime": {
"type": "string",
"format": "date-time"
},
"origin": {
"$ref": "#/components/schemas/InboxDocumentOrigin"
},
"manualUploadUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"manualUploadUserFullName": {
"type": "string",
"nullable": true
},
"authorizationStatus": {
"$ref": "#/components/schemas/InboxDocumentAuthorizationStatus"
},
"authorizationStatusTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"authorizationStatusUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"authorizationStatusUserFullName": {
"type": "string",
"nullable": true
},
"importStatus": {
"$ref": "#/components/schemas/InboxDocumentImportStatus"
},
"importStatusTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"importErrorCustomMessage": {
"type": "string",
"nullable": true
},
"importErrorKind": {
"$ref": "#/components/schemas/InboxDocumentImportErrorKind"
},
"exportStatus": {
"$ref": "#/components/schemas/InboxDocumentExportStatus"
},
"exportErrorMessage": {
"type": "string",
"nullable": true
},
"exportTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recognitionConfidence": {
"type": "number",
"format": "double",
"nullable": true
},
"isSplitRequired": {
"type": "boolean"
},
"channelId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"channelName": {
"type": "string",
"nullable": true
},
"categoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"categoryName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InboxDocumentListPublicAPIDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboxDocumentListPublicAPIDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"InboxDocumentOrigin": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "0 (Channel), 1 (ManualUpload), 2 (OtherAdministration), 3 (MobileApp), 4 (Api)",
"format": "int32",
"x-enumNames": [
"Channel",
"ManualUpload",
"OtherAdministration",
"MobileApp",
"Api"
]
},
"InboxDocumentRemarkDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"creatorUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"lastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastModifierUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"isDeleted": {
"type": "boolean"
},
"deleterUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"deletionTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"creatorUserUserName": {
"type": "string",
"nullable": true
},
"creatorUserFullName": {
"type": "string",
"nullable": true
},
"creatorUserProfilePictureId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"impersonatorUserId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"impersonatorUserUserName": {
"type": "string",
"nullable": true
},
"impersonatorUserFullName": {
"type": "string",
"nullable": true
},
"impersonatorUserProfilePictureId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"inboxDocumentId": {
"type": "integer",
"format": "int32"
},
"origin": {
"$ref": "#/components/schemas/RemarkOrigin"
}
},
"additionalProperties": false
},
"InboxDocumentType": {
"enum": [
0,
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": "0 (PaymentReminder), 1 (Invoice), 2 (Receipt), 3 (Quote), 4 (Order), 5 (Contract), 6 (Terms), 7 (PackingSlip), 8 (PriceList), 9 (Waybill), 10 (BankStatement), 11 (CreditCardStatement), 12 (CashStatement), 13 (VatReturn), 14 (DividendTax), 15 (IcpDeclaration), 16 (IncomeTax), 17 (PayrollTaxReturn), 18 (CorporateTax), 19 (TrafficFine), 20 (PaymentSpecification), 21 (Letter), 22 (TripRegistration), 23 (Payslip), 24 (InsurancePolicy), 25 (WorkOrder), 26 (OrderConfirmation), 27 (NotRecognized)",
"format": "int32",
"x-enumNames": [
"PaymentReminder",
"Invoice",
"Receipt",
"Quote",
"Order",
"Contract",
"Terms",
"PackingSlip",
"PriceList",
"Waybill",
"BankStatement",
"CreditCardStatement",
"CashStatement",
"VatReturn",
"DividendTax",
"IcpDeclaration",
"IncomeTax",
"PayrollTaxReturn",
"CorporateTax",
"TrafficFine",
"PaymentSpecification",
"Letter",
"TripRegistration",
"Payslip",
"InsurancePolicy",
"WorkOrder",
"OrderConfirmation",
"NotRecognized"
]
},
"IntraCommunityPerformanceType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Goods), 1 (Services)",
"format": "int32",
"x-enumNames": [
"Goods",
"Services"
]
},
"JournalListDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/JournalType"
},
"accountingSystemJournalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"JournalType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Sales), 1 (Purchase)",
"format": "int32",
"x-enumNames": [
"Sales",
"Purchase"
]
},
"LedgerAccountClassificationPublicAPIDto": {
"required": [
"classificationCode",
"classificationScheme",
"classificationSchemeCategory"
],
"type": "object",
"properties": {
"classificationSchemeCategory": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"classificationScheme": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"classificationCode": {
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"LedgerAccountDeductibilityPercentagePublicAPIDto": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"privateUsePercentage": {
"type": "number",
"format": "double"
},
"taxNonDeductiblePercentage": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"LedgerAccountLineCustomFieldSettingsDto": {
"type": "object",
"properties": {
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"isEnabled": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
}
},
"additionalProperties": false
},
"LedgerAccountProjectEntryConstraint": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (NotAllowed), 1 (Allowed), 2 (Required)",
"format": "int32",
"x-enumNames": [
"NotAllowed",
"Allowed",
"Required"
]
},
"LedgerAccountPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"isCostCentreEntryRequired": {
"type": "boolean"
},
"isCostUnitEntryRequired": {
"type": "boolean"
},
"isProductEntryRequired": {
"type": "boolean"
},
"isEmployeeEntryRequired": {
"type": "boolean"
},
"projectEntryConstraint": {
"$ref": "#/components/schemas/LedgerAccountProjectEntryConstraint"
},
"isTaxCodeAllowed": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/LedgerAccountType"
},
"isAFASAllocationAxle1EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle2EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle3EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle4EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle5EntryRequired": {
"type": "boolean"
},
"isCommitmentEntryInPurchaseTransactionsRequired": {
"type": "boolean"
},
"isTaxNonDeductiblePercentageChangingAllowed": {
"type": "boolean"
},
"isPrivateUsePercentageChangingAllowed": {
"type": "boolean"
},
"deductibilityPercentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountDeductibilityPercentagePublicAPIDto"
},
"nullable": true
},
"classifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountClassificationPublicAPIDto"
},
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"LedgerAccountPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"LedgerAccountType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Sales), 1 (Purchase), 2 (SalesAndPurchase)",
"format": "int32",
"x-enumNames": [
"Sales",
"Purchase",
"SalesAndPurchase"
]
},
"ListAIRApiModelsInput": {
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ListAccountsInputFilters": {
"type": "object",
"properties": {
"includedTagNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"excludedTagNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ListAdministrationsInput": {
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"filters": {
"$ref": "#/components/schemas/ListAdministrationsInputFilters"
}
},
"additionalProperties": false
},
"ListAdministrationsInputFilters": {
"type": "object",
"properties": {
"tagNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ListFinancialTransactionInputFilters": {
"type": "object",
"properties": {
"journalIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"journalType": {
"$ref": "#/components/schemas/JournalType"
},
"types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionType"
},
"nullable": true
},
"transactionDateFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"transactionDateTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fiscalYearFrom": {
"type": "string",
"nullable": true
},
"fiscalYearTo": {
"type": "string",
"nullable": true
},
"fiscalPeriodFrom": {
"type": "integer",
"format": "int32",
"nullable": true
},
"fiscalPeriodTo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"accountCode": {
"type": "string",
"nullable": true
},
"exportStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionExportStatus"
},
"nullable": true
},
"exportTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"exportTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"authorizationStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransactionAuthorizationStatus"
},
"nullable": true
},
"creationTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"creationTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastModificationTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastModificationTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isApproved": {
"type": "boolean",
"nullable": true
},
"approvalTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"approvalTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalTransactionNumberFrom": {
"type": "string",
"nullable": true
},
"externalTransactionNumberTo": {
"type": "string",
"nullable": true
},
"inboxDocumentReceivedTimeFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"inboxDocumentReceivedTimeTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"inboxDocumentOrigin": {
"$ref": "#/components/schemas/InboxDocumentOrigin"
},
"approvalUserFullName": {
"type": "string",
"nullable": true
},
"isApprovedByAutomationRule": {
"type": "boolean",
"nullable": true
},
"notPaidAmountFrom": {
"type": "number",
"format": "double",
"nullable": true
},
"notPaidAmountTo": {
"type": "number",
"format": "double",
"nullable": true
},
"accountTagNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isProposalChanged": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"ListFinancialTransactionsInput": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"maxResultCount": {
"maximum": 250,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"skipCount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sorting": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"filters": {
"$ref": "#/components/schemas/ListFinancialTransactionInputFilters"
}
},
"additionalProperties": false
},
"LocalizedTextDto": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ManageCustomFieldLedgerAccountsCommand": {
"required": [
"administrationId",
"name"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"ledgerAccountSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountLineCustomFieldSettingsDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ManageCustomFieldLookupsCommand": {
"required": [
"administrationId",
"name"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"name": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"customFieldLevel": {
"$ref": "#/components/schemas/CustomFieldLevel"
},
"lookupValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldLookupValueDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"PaymentConditionPaymentMethod": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"description": "0 (OnCredit), 1 (Collection), 2 (Cash), 3 (Creditcard)",
"format": "int32",
"x-enumNames": [
"OnCredit",
"Collection",
"Cash",
"Creditcard"
]
},
"PaymentConditionPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"paymentDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentMonths": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/PaymentConditionType"
},
"paymentMethod": {
"$ref": "#/components/schemas/PaymentConditionPaymentMethod"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"PaymentConditionPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentConditionPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PaymentConditionType": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "0 (DaysAfterInvoiceDate), 1 (MonthsAfterInvoiceDate), 2 (MonthsAfterInvoiceDateMonth), 3 (MonthsAfterInvoiceDateMonthPlusPaymentDays), 4 (UseAccountPaymentDueDays)",
"format": "int32",
"x-enumNames": [
"DaysAfterInvoiceDate",
"MonthsAfterInvoiceDate",
"MonthsAfterInvoiceDateMonth",
"MonthsAfterInvoiceDateMonthPlusPaymentDays",
"UseAccountPaymentDueDays"
]
},
"PaymentDiscountCalculationMethod": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (ExclusiveTax), 1 (InclusiveTax)",
"format": "int32",
"x-enumNames": [
"ExclusiveTax",
"InclusiveTax"
]
},
"PaymentDiscountTaxCalculationMethod": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Exclusive), 1 (Inclusive)",
"format": "int32",
"x-enumNames": [
"Exclusive",
"Inclusive"
]
},
"ProcessDocumentExcludedValue": {
"required": [
"fieldName",
"value"
],
"type": "object",
"properties": {
"fieldName": {
"minLength": 1,
"type": "string",
"description": "Field name. Must be one of the following values: InvoiceVatNumber, InvoiceIBAN, InvoiceCocNumber, AccountPostalCode, AccountTelephone."
},
"value": {
"minLength": 1,
"type": "string",
"description": "Value to be excluded."
}
},
"additionalProperties": false
},
"ProcessDocumentInput": {
"required": [
"fileName",
"legislation"
],
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Publicly reachable URL of a document. Provide either Zenvoices.PublicApi.Controllers.AIR.Models.ProcessDocumentInput.Url or Zenvoices.PublicApi.Controllers.AIR.Models.ProcessDocumentInput.Content.",
"nullable": true
},
"content": {
"type": "string",
"description": "Base64 encoded document content. Provide either Zenvoices.PublicApi.Controllers.AIR.Models.ProcessDocumentInput.Url or Zenvoices.PublicApi.Controllers.AIR.Models.ProcessDocumentInput.Content.",
"nullable": true
},
"fileName": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Document filename. Supported file extensions are: .pdf, .docx, .doc, .xlsx, .xls, .eml, .jpg, .jpeg, .png, .bmp."
},
"legislation": {
"minLength": 1,
"type": "string",
"description": "Code of the legislation that is used to extract tax amounts. Must be one of the supported legislations: nl, gb, de, be, pl, fr, es, usa."
},
"excludedValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProcessDocumentExcludedValue"
},
"description": "Field values that must not be extracted. For exampled used for ignoring own VAT or IBAN numbers.",
"nullable": true
},
"modelId": {
"type": "string",
"description": "Id of the model that must be used. If no model id is specified, our pre-trained model is used.",
"format": "uuid",
"nullable": true
},
"extractLineItems": {
"type": "boolean",
"description": "Bool indicating if line items should be extracted."
}
},
"additionalProperties": false
},
"ProcessDocumentOutput": {
"type": "object",
"properties": {
"operationId": {
"type": "string",
"description": "Id of the created operation.",
"format": "uuid"
},
"resultLocation": {
"type": "string",
"description": "Url of the operation result.",
"nullable": true
},
"resultExpiryTime": {
"type": "string",
"description": "Expiry time of the operation result.",
"format": "date-time"
}
},
"additionalProperties": false
},
"ProductApplication": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Sales), 1 (Purchase), 2 (SalesAndPurchase)",
"format": "int32",
"x-enumNames": [
"Sales",
"Purchase",
"SalesAndPurchase"
]
},
"ProductPublicAPIDetailsDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "User friendly product code. Has to be unique within one administration.",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"name": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"application": {
"$ref": "#/components/schemas/ProductApplication"
},
"salesUnit": {
"type": "string",
"nullable": true
},
"salesPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"salesTaxCode": {
"type": "string",
"nullable": true
},
"salesLedgerAccountCode": {
"type": "string",
"nullable": true
},
"purchaseUnit": {
"type": "string",
"nullable": true
},
"purchasePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseTaxCode": {
"type": "string",
"nullable": true
},
"purchaseLedgerAccountCode": {
"type": "string",
"nullable": true
},
"quantityNumberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"priceNumberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"administrationId": {
"type": "integer",
"description": "Administration id of the product",
"format": "int32"
},
"externalId": {
"type": "string",
"description": "Id from the external system. Has to be unique within one administration.",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"ProductPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProductType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Standard), 1 (Rate), 2 (Text)",
"format": "int32",
"x-enumNames": [
"Standard",
"Rate",
"Text"
]
},
"ProjectItemPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"projectCode": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"ProjectItemPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectItemPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProjectPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"purchaseTaxCode": {
"type": "string",
"nullable": true
},
"projectLeaderFullName": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"ProjectPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProjectStagePublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"projectCode": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"ProjectStagePublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectStagePublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PurchaseOrderLinePublicAPIDetailsDto": {
"type": "object",
"properties": {
"lineType": {
"$ref": "#/components/schemas/ExternalPurchaseOrderLineType"
},
"lineNumber": {
"type": "integer",
"format": "int32"
},
"productCode": {
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"supplierProductCode": {
"type": "string",
"nullable": true
},
"eanCode": {
"type": "string",
"nullable": true
},
"unit": {
"type": "string",
"nullable": true
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"salesOrderNumber": {
"type": "string",
"nullable": true
},
"salesOrderLineNumber": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"isCompletelyInvoiced": {
"type": "boolean",
"description": "Bool indicating that the line should be considered as completely invoiced."
},
"quantity": {
"type": "number",
"description": "Quantity ordered in purchase units (Zenvoices.MasterData.PurchaseOrders.Dto.PublicAPI.PurchaseOrderLinePublicAPIDetailsDto.Unit).",
"format": "double",
"nullable": true
},
"quantityInStockUnits": {
"type": "number",
"description": "Quantity ordered in stock units.",
"format": "double",
"nullable": true
},
"quantityReceived": {
"type": "number",
"description": "Quantity received in purchase units.",
"format": "double",
"nullable": true
},
"quantityInvoiced": {
"type": "number",
"description": "Quantity invoiced in purchase units, according to the external accounting system.",
"format": "double",
"nullable": true
},
"pricePer": {
"type": "number",
"description": "Specifies the number of purchase units to which the prices apply. E.g. if price per is 10, unit price is the price for 10 purchase units.",
"format": "double",
"nullable": true
},
"unitPrice": {
"type": "number",
"description": "Price per purchase unit (Zenvoices.MasterData.PurchaseOrders.Dto.PublicAPI.PurchaseOrderLinePublicAPIDetailsDto.Unit) in the purchase order currency (tax code taken into account).",
"format": "double",
"nullable": true
},
"netPrice": {
"type": "number",
"description": "Net price per purchase unit (Zenvoices.MasterData.PurchaseOrders.Dto.PublicAPI.PurchaseOrderLinePublicAPIDetailsDto.Unit) in the purchase order currency (tax code taken into account).",
"format": "double",
"nullable": true
},
"netPriceExclTax": {
"type": "number",
"description": "Net price per purchase unit (Zenvoices.MasterData.PurchaseOrders.Dto.PublicAPI.PurchaseOrderLinePublicAPIDetailsDto.Unit) in the purchase order currency (excl. tax).",
"format": "double",
"nullable": true
},
"taxRate": {
"type": "number",
"format": "double",
"nullable": true
},
"taxCode": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"description": "Total amount excl. tax in the purchase order currency excl. tax.",
"format": "double",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"projectCode": {
"type": "string",
"nullable": true
},
"projectItemCode": {
"type": "string",
"nullable": true
},
"chargeProjectCosts": {
"type": "boolean"
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"costCentreCode": {
"type": "string",
"nullable": true
},
"costUnitCode": {
"type": "string",
"nullable": true
},
"afasAxle1AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle2AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle3AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle4AllocationCode": {
"type": "string",
"nullable": true
},
"afasAxle5AllocationCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PurchaseOrderLinePublicAPIEditDto": {
"required": [
"externalId"
],
"type": "object",
"properties": {
"lineType": {
"$ref": "#/components/schemas/ExternalPurchaseOrderLineType"
},
"lineNumber": {
"minimum": 0,
"type": "integer",
"format": "int32"
},
"productCode": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"supplierProductCode": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"eanCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"unit": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"salesOrderNumber": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"salesOrderLineNumber": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"isCompletelyInvoiced": {
"type": "boolean"
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityInStockUnits": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityReceived": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityInvoiced": {
"type": "number",
"format": "double",
"nullable": true
},
"pricePer": {
"type": "number",
"format": "double",
"nullable": true
},
"unitPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"netPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"netPriceExclTax": {
"type": "number",
"format": "double",
"nullable": true
},
"taxRate": {
"type": "number",
"format": "double",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"projectCode": {
"type": "string",
"nullable": true
},
"projectItemCode": {
"type": "string",
"nullable": true
},
"chargeProjectCosts": {
"type": "boolean"
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"costCentreCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"costUnitCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"afasAxle1AllocationCode": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"afasAxle2AllocationCode": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"afasAxle3AllocationCode": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"afasAxle4AllocationCode": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"afasAxle5AllocationCode": {
"maxLength": 20,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PurchaseOrderPublicAPIDetailsDto": {
"type": "object",
"properties": {
"purchaseOrderNumber": {
"type": "string",
"nullable": true
},
"purchaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"accountCode": {
"type": "string",
"nullable": true
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"customerReference": {
"type": "string",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"warehouseCode": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"isDropShipment": {
"type": "boolean"
},
"taxExclusiveAmount": {
"type": "number",
"description": "Tax exclusive amount in the currency of the purchase order.",
"format": "double",
"nullable": true
},
"totalTaxAmount": {
"type": "number",
"description": "Total tax amount in the currency of the purchase order.",
"format": "double",
"nullable": true
},
"taxInclusiveAmount": {
"type": "number",
"description": "Tax inclusive amount in the currency of the purchase order.",
"format": "double",
"nullable": true
},
"externalCreatorUserFullName": {
"type": "string",
"nullable": true
},
"externalCreationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalLastModifierUserFullName": {
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderLinePublicAPIDetailsDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"PurchaseOrderPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"RefreshTokenInput": {
"type": "object",
"properties": {
"refreshToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RefreshTokenResult": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"nullable": true
},
"accessTokenExpirationDateTimeUtc": {
"type": "string",
"format": "date-time"
},
"expireInSeconds": {
"type": "integer",
"format": "int32"
},
"refreshToken": {
"type": "string",
"nullable": true
},
"refreshTokenExpireInSeconds": {
"type": "integer",
"format": "int32"
},
"refreshTokenExpirationDateTimeUtc": {
"type": "string",
"format": "date-time"
},
"encryptedAccessToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RejectFinancialTransactionsCommand": {
"required": [
"financialTransactionIds"
],
"type": "object",
"properties": {
"financialTransactionIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"remark": {
"maxLength": 10000,
"type": "string",
"nullable": true
},
"invoiceResponseMessageRejectClarification": {
"maxLength": 10000,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RemarkOrigin": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"description": "0 (ManualEntry), 1 (Authorization), 2 (AutomaticallyGenerated), 3 (FromEmail), 4 (FromAPI)",
"format": "int32",
"x-enumNames": [
"ManualEntry",
"Authorization",
"AutomaticallyGenerated",
"FromEmail",
"FromAPI"
]
},
"ScanAndRecognizeDateParsingPreference": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (None), 1 (American), 2 (English)",
"format": "int32",
"x-enumNames": [
"None",
"American",
"English"
]
},
"ScanAndRecognizeDocumentTypeRecognitionMethod": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Automatic), 1 (ReceiptFixed), 2 (InvoiceFixed)",
"format": "int32",
"x-enumNames": [
"Automatic",
"ReceiptFixed",
"InvoiceFixed"
]
},
"SelectListGroup": {
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SelectListItem": {
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
},
"group": {
"$ref": "#/components/schemas/SelectListGroup"
},
"selected": {
"type": "boolean"
},
"text": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SendTwoFactorAuthCodeInput": {
"required": [
"selectedProvider"
],
"type": "object",
"properties": {
"loginVerificationCode": {
"type": "string",
"nullable": true
},
"selectedProvider": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"StartMasterDataUpdateCommand": {
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"format": "int32"
},
"isIncremental": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TableHeaderType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (String), 1 (Decimal), 2 (Percentage)",
"format": "int32",
"x-enumNames": [
"String",
"Decimal",
"Percentage"
]
},
"TaxCodeCalculationMode": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Exclusive), 1 (Inclusive)",
"format": "int32",
"x-enumNames": [
"Exclusive",
"Inclusive"
]
},
"TaxCodePercentagePublicAPIDto": {
"required": [
"rate"
],
"type": "object",
"properties": {
"rate": {
"type": "number",
"format": "double"
},
"validFrom": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TaxCodePublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/TaxCodeType"
},
"calculationMode": {
"$ref": "#/components/schemas/TaxCodeCalculationMode"
},
"isIcp": {
"type": "boolean"
},
"isCharged": {
"type": "boolean"
},
"percentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCodePercentagePublicAPIDto"
},
"nullable": true
},
"ledgerAccountCode": {
"type": "string",
"nullable": true
},
"chargedLedgerAccountCode": {
"type": "string",
"nullable": true
},
"isIntrastatEntryAllowed": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TaxCodePublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCodePublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TaxCodeType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Sales), 1 (Purchase), 2 (SalesAndPurchase)",
"format": "int32",
"x-enumNames": [
"Sales",
"Purchase",
"SalesAndPurchase"
]
},
"TaxScenarioLocation": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Domestic), 1 (EU), 2 (NonEU)",
"format": "int32",
"x-enumNames": [
"Domestic",
"EU",
"NonEU"
]
},
"TaxScenarioPublicAPIDetailsDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"taxScenarioType": {
"$ref": "#/components/schemas/TaxScenarioType"
},
"taxScenarioLocation": {
"$ref": "#/components/schemas/TaxScenarioLocation"
},
"taxOnInvoice": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TaxScenarioPublicAPIDetailsDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxScenarioPublicAPIDetailsDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TaxScenarioType": {
"enum": [
0,
1,
2
],
"type": "integer",
"description": "0 (Purchase), 1 (Sales), 2 (SalesAndPurchase)",
"format": "int32",
"x-enumNames": [
"Purchase",
"Sales",
"SalesAndPurchase"
]
},
"TrainAIRApiModelInput": {
"type": "object",
"properties": {
"modelId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"UpdateAccountByCodeCommand": {
"required": [
"accountAddress",
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
},
"searchCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"vatNumber": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"chamberOfCommerceNumber": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"iban": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"bic": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"paymentDueDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"paymentConditionCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxScenarioCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"accountAddress": {
"$ref": "#/components/schemas/AccountAddressPublicAPIEditDto"
},
"includeInSupplierPaymentBatches": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"financialTransactionProposalStrategy": {
"$ref": "#/components/schemas/FinancialTransactionProposalStrategy"
},
"dontAskToUpdateMasterData": {
"type": "boolean"
},
"isFinancialTransactionIBANCheckEnabled": {
"type": "boolean"
},
"isFinancialTransactionVATNumberCheckEnabled": {
"type": "boolean"
},
"includeInInternalPaymentBatch": {
"type": "boolean"
},
"defaultFinancialTransactionType": {
"$ref": "#/components/schemas/AccountDefaultFinancialTransactionTypeSetting"
},
"paymentDiscountPercentage": {
"type": "number",
"format": "double"
},
"externalPaymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountTaxCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountTaxCalculationMethod"
},
"scanAndRecognizeDocumentTypeRecognitionMethod": {
"$ref": "#/components/schemas/ScanAndRecognizeDocumentTypeRecognitionMethod"
},
"scanAndRecognizeDateParsingPreference": {
"$ref": "#/components/schemas/ScanAndRecognizeDateParsingPreference"
},
"gAccountAmountCalculationMode": {
"$ref": "#/components/schemas/FinancialTransactionGAccountAmountCalculationMode"
},
"gAccountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateAccountByExternalIdCommand": {
"required": [
"accountAddress",
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/AccountType"
},
"searchCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"vatNumber": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"chamberOfCommerceNumber": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"iban": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"bic": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"paymentDueDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"paymentConditionCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxScenarioCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"accountAddress": {
"$ref": "#/components/schemas/AccountAddressPublicAPIEditDto"
},
"includeInSupplierPaymentBatches": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"financialTransactionProposalStrategy": {
"$ref": "#/components/schemas/FinancialTransactionProposalStrategy"
},
"dontAskToUpdateMasterData": {
"type": "boolean"
},
"isFinancialTransactionIBANCheckEnabled": {
"type": "boolean"
},
"isFinancialTransactionVATNumberCheckEnabled": {
"type": "boolean"
},
"includeInInternalPaymentBatch": {
"type": "boolean"
},
"defaultFinancialTransactionType": {
"$ref": "#/components/schemas/AccountDefaultFinancialTransactionTypeSetting"
},
"paymentDiscountPercentage": {
"type": "number",
"format": "double"
},
"externalPaymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountCalculationMethod"
},
"paymentDiscountTaxCalculationMethod": {
"$ref": "#/components/schemas/PaymentDiscountTaxCalculationMethod"
},
"scanAndRecognizeDocumentTypeRecognitionMethod": {
"$ref": "#/components/schemas/ScanAndRecognizeDocumentTypeRecognitionMethod"
},
"scanAndRecognizeDateParsingPreference": {
"$ref": "#/components/schemas/ScanAndRecognizeDateParsingPreference"
},
"gAccountAmountCalculationMode": {
"$ref": "#/components/schemas/FinancialTransactionGAccountAmountCalculationMode"
},
"gAccountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"gAccountAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateAllocationCodeByCodeCommand": {
"required": [
"administrationId",
"allocationAxleCode",
"code",
"externalId",
"ledgerAccountCode"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"allocationAxleCode": {
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"allocationAxleDescription": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"code": {
"maxLength": 20,
"minLength": 1,
"type": "string"
},
"description": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateAllocationCodeByExternalIdCommand": {
"required": [
"administrationId",
"allocationAxleCode",
"code",
"externalId",
"ledgerAccountCode"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"allocationAxleCode": {
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"allocationAxleDescription": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"code": {
"maxLength": 20,
"minLength": 1,
"type": "string"
},
"description": {
"maxLength": 50,
"type": "string",
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCommitmentByCodeCommand": {
"required": [
"accountCode",
"administrationId",
"code"
],
"type": "object",
"properties": {
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"type": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"reference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"internalReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"externalReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"contractName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"accountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"productCode": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"projectCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"projectItemCode": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectStageCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"fiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"periodStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"openAmount": {
"type": "number",
"format": "double"
},
"allocationAxleCode1": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode2": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode3": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode4": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode5": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"externalId": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCommitmentByExternalIdCommand": {
"required": [
"accountCode",
"administrationId",
"code"
],
"type": "object",
"properties": {
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"type": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"reference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"internalReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"externalReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"contractName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"accountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"productCode": {
"maxLength": 64,
"type": "string",
"nullable": true
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"projectCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"projectItemCode": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectStageCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"fiscalYear": {
"type": "string",
"nullable": true
},
"fiscalPeriod": {
"type": "integer",
"format": "int32",
"nullable": true
},
"periodStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"openAmount": {
"type": "number",
"format": "double"
},
"allocationAxleCode1": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode2": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode3": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode4": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"allocationAxleCode5": {
"maxLength": 20,
"type": "string",
"nullable": true
},
"externalId": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCostCentreByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCostCentreByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCostUnitByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCostUnitByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCountryByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 10,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCountryByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 10,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCurrencyByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"priceNumberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateCurrencyByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"priceNumberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateEmployeeByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"fullName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"costCentreCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateEmployeeByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"fullName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"costCentreCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateExportStatusCommand": {
"required": [
"financialTransactionId"
],
"type": "object",
"properties": {
"financialTransactionId": {
"type": "integer",
"format": "int32"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"externalTransactionNumber": {
"type": "string",
"nullable": true
},
"exportStatus": {
"$ref": "#/components/schemas/FinancialTransactionExportStatus"
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateFiscalPeriodByExternalIdCommand": {
"required": [
"administrationId",
"externalId",
"fiscalYear"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"fiscalYear": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"period": {
"minimum": 0,
"type": "integer",
"format": "int32"
},
"description": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateFiscalPeriodByFiscalYearCommand": {
"required": [
"administrationId",
"externalId",
"fiscalYear"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"fiscalYear": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"period": {
"minimum": 0,
"type": "integer",
"format": "int32"
},
"description": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateLedgerAccountByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"isCostCentreEntryRequired": {
"type": "boolean"
},
"isCostUnitEntryRequired": {
"type": "boolean"
},
"isProductEntryRequired": {
"type": "boolean"
},
"isEmployeeEntryRequired": {
"type": "boolean"
},
"projectEntryConstraint": {
"$ref": "#/components/schemas/LedgerAccountProjectEntryConstraint"
},
"isTaxCodeAllowed": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/LedgerAccountType"
},
"isAFASAllocationAxle1EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle2EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle3EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle4EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle5EntryRequired": {
"type": "boolean"
},
"isCommitmentEntryInPurchaseTransactionsRequired": {
"type": "boolean"
},
"isTaxNonDeductiblePercentageChangingAllowed": {
"type": "boolean"
},
"isPrivateUsePercentageChangingAllowed": {
"type": "boolean"
},
"deductibilityPercentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountDeductibilityPercentagePublicAPIDto"
},
"nullable": true
},
"classifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountClassificationPublicAPIDto"
},
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateLedgerAccountByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"taxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"isCostCentreEntryRequired": {
"type": "boolean"
},
"isCostUnitEntryRequired": {
"type": "boolean"
},
"isProductEntryRequired": {
"type": "boolean"
},
"isEmployeeEntryRequired": {
"type": "boolean"
},
"projectEntryConstraint": {
"$ref": "#/components/schemas/LedgerAccountProjectEntryConstraint"
},
"isTaxCodeAllowed": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/LedgerAccountType"
},
"isAFASAllocationAxle1EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle2EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle3EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle4EntryRequired": {
"type": "boolean"
},
"isAFASAllocationAxle5EntryRequired": {
"type": "boolean"
},
"isCommitmentEntryInPurchaseTransactionsRequired": {
"type": "boolean"
},
"isTaxNonDeductiblePercentageChangingAllowed": {
"type": "boolean"
},
"isPrivateUsePercentageChangingAllowed": {
"type": "boolean"
},
"deductibilityPercentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountDeductibilityPercentagePublicAPIDto"
},
"nullable": true
},
"classifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerAccountClassificationPublicAPIDto"
},
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdatePaymentConditionByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"paymentDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentMonths": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/PaymentConditionType"
},
"paymentMethod": {
"$ref": "#/components/schemas/PaymentConditionPaymentMethod"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdatePaymentConditionByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"paymentDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentMonths": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/PaymentConditionType"
},
"paymentMethod": {
"$ref": "#/components/schemas/PaymentConditionPaymentMethod"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProductByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"code": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "User friendly product code. Has to be unique within one administration."
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"name": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"application": {
"$ref": "#/components/schemas/ProductApplication"
},
"salesUnit": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"salesPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"salesTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"salesLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"purchaseUnit": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"purchasePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"purchaseLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"quantityNumberOfDecimals": {
"maximum": 6,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"priceNumberOfDecimals": {
"maximum": 6,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"administrationId": {
"type": "integer",
"description": "Administration id of the product",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "Id from the external system. Has to be unique within one administration."
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProductByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"code": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "User friendly product code. Has to be unique within one administration."
},
"productType": {
"$ref": "#/components/schemas/ProductType"
},
"name": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"application": {
"$ref": "#/components/schemas/ProductApplication"
},
"salesUnit": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"salesPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"salesTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"salesLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"purchaseUnit": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"purchasePrice": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"purchaseLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"quantityNumberOfDecimals": {
"maximum": 6,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"priceNumberOfDecimals": {
"maximum": 6,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"administrationId": {
"type": "integer",
"description": "Administration id of the product",
"format": "int32"
},
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "Id from the external system. Has to be unique within one administration."
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProjectByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"purchaseTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"projectLeaderFullName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProjectByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"purchaseTaxCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"projectLeaderFullName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProjectItemByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProjectItemByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProjectStageByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId",
"projectCode"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateProjectStageByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId",
"projectCode"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"projectCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdatePurchaseOrderByExternalIdCommand": {
"required": [
"accountCode",
"administrationId",
"purchaseDate",
"purchaseOrderNumber"
],
"type": "object",
"properties": {
"purchaseOrderNumber": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"purchaseDate": {
"minLength": 1,
"type": "string",
"format": "date-time"
},
"accountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"customerReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"warehouseCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"isDropShipment": {
"type": "boolean"
},
"taxExclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalTaxAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"taxInclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"externalCreatorUserFullName": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalCreationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalLastModifierUserFullName": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalId": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderLinePublicAPIEditDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdatePurchaseOrderCommand": {
"required": [
"accountCode",
"administrationId",
"purchaseDate",
"purchaseOrderNumber"
],
"type": "object",
"properties": {
"purchaseOrderNumber": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"purchaseDate": {
"minLength": 1,
"type": "string",
"format": "date-time"
},
"accountCode": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"customerReference": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"currencyCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"warehouseCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"isDropShipment": {
"type": "boolean"
},
"taxExclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalTaxAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"taxInclusiveAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"externalCreatorUserFullName": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalCreationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalLastModifierUserFullName": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalId": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderLinePublicAPIEditDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"UpdateTaxCodeByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/TaxCodeType"
},
"calculationMode": {
"$ref": "#/components/schemas/TaxCodeCalculationMode"
},
"isIcp": {
"type": "boolean"
},
"isCharged": {
"type": "boolean"
},
"percentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCodePercentagePublicAPIDto"
},
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"chargedLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"isIntrastatEntryAllowed": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateTaxCodeByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/TaxCodeType"
},
"calculationMode": {
"$ref": "#/components/schemas/TaxCodeCalculationMode"
},
"isIcp": {
"type": "boolean"
},
"isCharged": {
"type": "boolean"
},
"percentages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCodePercentagePublicAPIDto"
},
"nullable": true
},
"ledgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"chargedLedgerAccountCode": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"isIntrastatEntryAllowed": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateTaxScenarioByCodeCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"fiscalYear": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxScenarioType": {
"$ref": "#/components/schemas/TaxScenarioType"
},
"taxScenarioLocation": {
"$ref": "#/components/schemas/TaxScenarioLocation"
},
"taxOnInvoice": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateTaxScenarioByExternalIdCommand": {
"required": [
"administrationId",
"code",
"externalId",
"name"
],
"type": "object",
"properties": {
"externalId": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"administrationId": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"fiscalYear": {
"maxLength": 32,
"type": "string",
"nullable": true
},
"taxScenarioType": {
"$ref": "#/components/schemas/TaxScenarioType"
},
"taxScenarioLocation": {
"$ref": "#/components/schemas/TaxScenarioLocation"
},
"taxOnInvoice": {
"type": "boolean"
},
"externalLastModificationTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UploadDocument": {
"required": [
"fileName"
],
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Publicly reachable URL of a document.",
"nullable": true
},
"fileName": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Document filename."
},
"importAttachment": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UploadDocumentInput": {
"required": [
"administrationId",
"fileName"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"description": "Administration id of the document.",
"format": "int32"
},
"designatedJournalId": {
"type": "integer",
"description": "Designated journal id of the document.",
"format": "int32",
"nullable": true
},
"designatedCategoryId": {
"type": "integer",
"description": "Designated category id of the document.",
"format": "int32",
"nullable": true
},
"url": {
"type": "string",
"description": "Publicly reachable URL of a document. Provide either Zenvoices.PublicApi.Controllers.Inbox.Models.UploadDocumentInput.Url or Zenvoices.PublicApi.Controllers.Inbox.Models.UploadDocumentInput.Content.",
"nullable": true
},
"content": {
"type": "string",
"description": "Base64 encoded document content. Provide either Zenvoices.PublicApi.Controllers.Inbox.Models.UploadDocumentInput.Url or Zenvoices.PublicApi.Controllers.Inbox.Models.UploadDocumentInput.Content.",
"nullable": true
},
"fileName": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Document filename."
},
"externalId": {
"maxLength": 256,
"type": "string",
"description": "External id of the document. If set and a document with the same external id already exists in the administration, an error is returned.",
"nullable": true
},
"senderName": {
"maxLength": 256,
"type": "string",
"description": "User friendly name of the document sender, which is shown to users.",
"nullable": true
},
"senderId": {
"maxLength": 256,
"type": "string",
"description": "Identifier of the document sender, which is available for automation rules (e.g. to automatically import or route documents).",
"nullable": true
},
"remarkText": {
"maxLength": 10000,
"type": "string",
"description": "Remark of the document.",
"nullable": true
},
"categoryId": {
"type": "integer",
"description": "Inbox document category id.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"UploadDocumentsInput": {
"required": [
"administrationId"
],
"type": "object",
"properties": {
"administrationId": {
"type": "integer",
"description": "Administration id of the document.",
"format": "int32"
},
"designatedJournalId": {
"type": "integer",
"description": "Designated journal id of the document.",
"format": "int32",
"nullable": true
},
"designatedCategoryId": {
"type": "integer",
"description": "Designated category id of the document.",
"format": "int32",
"nullable": true
},
"externalId": {
"maxLength": 256,
"type": "string",
"description": "External id of the document. If set and a document with the same external id already exists in the administration, an error is returned.",
"nullable": true
},
"senderName": {
"maxLength": 256,
"type": "string",
"description": "User friendly name of the document sender, which is shown to users.",
"nullable": true
},
"senderId": {
"maxLength": 256,
"type": "string",
"description": "Identifier of the document sender, which is available for automation rules (e.g. to automatically import or route documents).",
"nullable": true
},
"remarkText": {
"maxLength": 10000,
"type": "string",
"description": "Remark of the document.",
"nullable": true
},
"categoryId": {
"type": "integer",
"description": "Inbox document category id.",
"format": "int32",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UploadDocument"
},
"nullable": true
}
},
"additionalProperties": false
},
"UserDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"surname": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"profilePictureId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isEmailConfirmed": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserListRoleDto"
},
"nullable": true
},
"isActive": {
"type": "boolean"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"isTwoFactorEnabled": {
"type": "boolean"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"externalReferenceCode": {
"type": "string",
"nullable": true
},
"grantedPermissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Granted permissions of the user.",
"nullable": true
},
"grantedAdministrationIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Granted administration ids of the user (either on user or role level). Null if Zenvoices.PublicApi.Controllers.Users.Models.UserDto.AreAllAdministrationsGranted is True.",
"nullable": true
},
"areAllAdministrationsGranted": {
"type": "boolean",
"description": "Bool indicating if access to all administrations is granted."
}
},
"additionalProperties": false
},
"UserListDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string",
"nullable": true
},
"surname": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"profilePictureId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isEmailConfirmed": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserListRoleDto"
},
"nullable": true
},
"isActive": {
"type": "boolean"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"isTwoFactorEnabled": {
"type": "boolean"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"externalReferenceCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserListDtoPagedResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserListDto"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"UserListRoleDto": {
"type": "object",
"properties": {
"roleId": {
"type": "integer",
"format": "int32"
},
"roleName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ValidateOperationResultInput": {
"required": [
"correctValues",
"operationId"
],
"type": "object",
"properties": {
"operationId": {
"type": "string",
"description": "Id of the operation.",
"format": "uuid"
},
"correctValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldWithCorrectValue"
},
"description": "List with correct values."
},
"correctTables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidateTableResult"
},
"description": "List of correct tables expected from line item recognition.",
"nullable": true
}
},
"additionalProperties": false
},
"ValidateTableResult": {
"type": "object",
"properties": {
"tableInfo": {
"$ref": "#/components/schemas/AIRApiRawTableInfo"
},
"tableHeaders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AIRApiTableHeaderValidation"
},
"description": "List of correct header names.",
"nullable": true
}
},
"additionalProperties": false
},
"ValidationErrorInfo": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"WebhookListDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Unique name of the webhook.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Display name of the webhook.\r\nOptional.",
"nullable": true
},
"description": {
"type": "string",
"description": "Description for the webhook.\r\nOptional.",
"nullable": true
}
},
"additionalProperties": false
},
"WebhookListDtoListResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookListDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"WebhookSubscriptionListDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"webhookUri": {
"type": "string",
"description": "Subscription webhook endpoint",
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Is subscription active"
},
"name": {
"type": "string",
"description": "Name of the subscription",
"nullable": true
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Gets a set of additional HTTP headers. These headers will be sent with the webhook.",
"nullable": true
},
"administrationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of administration ids to which the webhook subscription is applied",
"nullable": true
}
},
"additionalProperties": false
},
"WebhookSubscriptionListDtoListResultDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookSubscriptionListDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ZenvoicesWebhookSubscriptionDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"administrationIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"webhookUri": {
"type": "string",
"nullable": true
},
"secret": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"webhooks": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "http",
"description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",
"scheme": "bearer"
}
}
},
"security": [
{
"Bearer": [
"Bearer"
]
}
]
}