{ "x-generator": "NSwag v14.4.0.0 (NJsonSchema v11.3.2.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "mPohoda API", "description": "API aplikace mPohoda.", "version": "v1.0", "x-logo": { "url": "https://app.mpohoda.cz/images/common/Menu/mph-logo.svg", "backgroundColor": "#1A237E", "altText": "mPohoda" } }, "servers": [ { "url": "https://api.mpohoda.cz" } ], "paths": { "/v1/Activities": { "get": { "tags": [ "Activities" ], "summary": "Activities paginated.", "description": "Gets all Activities by specified pagination.", "operationId": "MphOpenApiApiEndpointsListsActivitiesActivitiesGroup+ActivityListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfActivityDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.ActivitiesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Activities/{id}": { "get": { "tags": [ "Activities" ], "summary": "Gets Activity by id.", "description": "Retrieves Activity by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsListsActivitiesActivitiesGroup+ActivityGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.ActivitiesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/BankAccounts": { "get": { "tags": [ "BankAccounts" ], "summary": "Bank accounts paginated.", "description": "Gets all Bank accounts by specified pagination.", "operationId": "MphOpenApiApiEndpointsListsBankAccountsBankAccountsGroup+BankAccountListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfBankAccountDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.BankAccountsClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/BankAccounts/{id}": { "get": { "tags": [ "BankAccounts" ], "summary": "Gets Bank account by id.", "description": "Retrieves Bank account by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsListsBankAccountsBankAccountsGroup+BankAccountGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.BankAccountsClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Banks": { "get": { "tags": [ "Banks" ], "summary": "Banks paginated.", "description": "Gets all Banks by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsBanksBanksGroup+BankListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfBankDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.BanksClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Banks/{id}": { "get": { "tags": [ "Banks" ], "summary": "Gets Bank by id.", "description": "Retrieves Bank by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsBanksBanksGroup+BankGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.BanksClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/BusinessPartners": { "get": { "tags": [ "BusinessPartners" ], "summary": "Business partners paginated.", "description": "Gets all Business partners by specified pagination.", "operationId": "MphOpenApiApiEndpointsBusinessPartnersBusinessPartnersGroup+CzechBusinessPartnerListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfBusinessPartnerDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.BusinessPartnersClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "BusinessPartners" ], "summary": "Creates Business partner.", "description": "Creates Business partner by passed payload.", "operationId": "MphOpenApiApiEndpointsBusinessPartnersBusinessPartnersGroup+CzechCreateBusinessPartnerPostEndpoint", "requestBody": { "x-name": "CreateBusinessPartnerDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBusinessPartnerDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfBusinessPartnerDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateBusinessPartnerDto\r\n{\r\n Name = \"STORMWARE s.r.o.\",\r\n City = \"Jihlava\",\r\n BusinessDetails = new CreateBusinessPartnerBusinessDetailsDto\r\n {\r\n DuePeriod = 20\r\n },\r\n DeliveryAddresses = new List\r\n {\r\n new()\r\n {\r\n Name = \"Tester\"\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.BusinessPartnersClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/BusinessPartners/{id}": { "get": { "tags": [ "BusinessPartners" ], "summary": "Gets Business partner by id.", "description": "Retrieves Business partner by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsBusinessPartnersBusinessPartnersGroup+CzechBusinessPartnerGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessPartnerDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.BusinessPartnersClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n // success code\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/CashRegisters": { "get": { "tags": [ "CashRegisters" ], "summary": "Cash registers paginated.", "description": "Gets all Cash registers by specified pagination.", "operationId": "MphOpenApiApiEndpointsListsCashRegistersCashRegistersGroup+CashRegisterListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfCashRegisterDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.CashRegistersClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/CashRegisters/{id}": { "get": { "tags": [ "CashRegisters" ], "summary": "Gets Cash register by id.", "description": "Retrieves Cash register by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsListsCashRegistersCashRegistersGroup+CashRegisterGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashRegisterDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.CashRegistersClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Centres": { "get": { "tags": [ "Centres" ], "summary": "Centres paginated.", "description": "Gets all Centres by specified pagination.", "operationId": "MphOpenApiApiEndpointsListsCentresCentresGroup+CentreListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfCentreDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.CentresClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Centres/{id}": { "get": { "tags": [ "Centres" ], "summary": "Gets Centre by id.", "description": "Retrieves Centre by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsListsCentresCentresGroup+CentreGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CentreDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.CentresClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/CityPostCodes": { "get": { "tags": [ "CityPostCodes" ], "summary": "City post codes paginated.", "description": "Gets all City post codes by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsCityPostCodesCityPostCodesGroup+CityPostCodeListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfCityPostCodeDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.CityPostCodesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/CityPostCodes/{id}": { "get": { "tags": [ "CityPostCodes" ], "summary": "Gets City post code by id.", "description": "Retrieves City post code by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsCityPostCodesCityPostCodesGroup+CityPostCodeGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CityPostCodeDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.CityPostCodesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Countries": { "get": { "tags": [ "Countries" ], "summary": "Countries paginated.", "description": "Gets all Countries by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsCountriesCountriesGroup+CountryListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfCountryDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.CountriesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Countries/{id}": { "get": { "tags": [ "Countries" ], "summary": "Gets Country by id.", "description": "Retrieves Country by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsCountriesCountriesGroup+CountryGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.CountriesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Currencies": { "get": { "tags": [ "Currencies" ], "summary": "Currencies paginated.", "description": "Gets all Currencies by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsCurrenciesCurrenciesGroup+CurrencyListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfCurrencyDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.CurrenciesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Currencies/{id}": { "get": { "tags": [ "Currencies" ], "summary": "Gets Currency by id.", "description": "Retrieves Currency by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsCurrenciesCurrenciesGroup+CurrencyGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.CurrenciesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Establishments": { "get": { "tags": [ "Establishments" ], "summary": "Establishments paginated.", "description": "Gets all Establishments by specified pagination.", "operationId": "MphOpenApiApiEndpointsListsEstablishmentsEstablishmentsGroup+EstablishmentListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfEstablishmentDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.EstablishmentsClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Establishments/{id}": { "get": { "tags": [ "Establishments" ], "summary": "Gets Establishment by id.", "description": "Retrieves Establishment by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsListsEstablishmentsEstablishmentsGroup+EstablishmentGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstablishmentDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.EstablishmentsClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ExchangeRates": { "get": { "tags": [ "ExchangeRates" ], "summary": "Exchange rate sets paginated.", "description": "Gets all Exchange rate sets by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsExchangeRatesExchangeRatesGroup+ExchangeRateListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfExchangeRateSetDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.ExchangeRatesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ExchangeRates/{id}": { "get": { "tags": [ "ExchangeRates" ], "summary": "Gets Exchange rate set by id.", "description": "Retrieves Exchange rate set by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsExchangeRatesExchangeRatesGroup+ExchangeRateGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeRateSetDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.ExchangeRatesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices": { "get": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Issued advance invoices paginated.", "description": "Gets all Issued advance invoices by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+CzechIssuedAdvanceInvoiceListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfIssuedAdvanceInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Creates Issued advance invoice.", "description": "Creates Issued advance invoice by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+CzechCreateIssuedAdvanceInvoicePostEndpoint", "requestBody": { "x-name": "CreateIssuedAdvanceInvoiceDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIssuedAdvanceInvoiceDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfIssuedAdvanceInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateIssuedAdvanceInvoiceDto\r\n{\r\n Items = new List\r\n {\r\n new()\r\n {\r\n // advance invoice has to be created with positive amount!\r\n TextItem = new CreateIssuedAdvanceInvoiceTextItemDto\r\n {\r\n Quantity = 1,\r\n UnitPrice = 1\r\n }\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices/{DocumentId}/Liquidate/Standalone/Fully": { "post": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Creates Liquidation.", "description": "Creates Liquidation by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+CreateFullIssuedAdvanceInvoiceLiquidationPostEndpoint", "parameters": [ { "name": "DocumentId", "in": "path", "required": true, "description": "Issued invoice id.", "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "requestBody": { "x-name": "CreateFullIssuedAdvanceInvoiceLiquidationDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFullIssuedAdvanceInvoiceLiquidationDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfLiquidationDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateFullIssuedAdvanceInvoiceLiquidationDto\r\n{\r\n DocumentId = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.Liquidate(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices/{id}": { "get": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Gets Issued advance invoice by id.", "description": "Retrieves Issued advance invoice by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+CzechIssuedAdvanceInvoiceGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedAdvanceInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices/{id}/isdoc": { "get": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Issued advance invoice ISDOC by id.", "description": "Retrieves Issued advance invoice ISDOC.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+IssuedAdvanceInvoiceGetIsdocEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.GetIsdoc(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices/{id}/pdf": { "get": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Advance invoice pdf by id.", "description": "Retrieves Advance invoice pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+IssuedAdvanceInvoiceGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices/{id}/RestToPay": { "get": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Gets Document payment status by id.", "description": "Retrieves Document payment status by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+IssuedAdvanceInvoiceRestToPayGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentPaymentStatusDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.GetRestToPay(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices/Liquidation/{id}": { "get": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Gets Liquidation by id.", "description": "Retrieves Liquidation by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+IssuedAdvanceInvoiceLiquidationGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidationDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.GetLiquidation(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedAdvanceInvoices/Unpaid": { "get": { "tags": [ "IssuedAdvanceInvoices" ], "summary": "Document payment statuses paginated.", "description": "Gets all Document payment statuses by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedAdvanceInvoicesIssuedAdvanceInvoicesGroup+IssuedAdvanceInvoiceUnpaidGetEndpoint", "parameters": [ { "name": "After", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfDocumentPaymentStatusDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssuedAdvanceInvoicesClient.GetAllUnpaidPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoiceCorrectiveTaxDocuments": { "get": { "tags": [ "IssuedInvoiceCorrectiveTaxDocuments" ], "summary": "Issued invoice corrective tax documents paginated.", "description": "Gets all Issued invoice corrective tax documents by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoiceCorrectiveTaxDocumentsIssuedInvoiceCorrectiveTaxDocumentsGroup+IssuedInvoiceCorrectiveTaxDocumentListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfIssuedInvoiceCorrectiveTaxDocumentDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssuedInvoiceCorrectiveTaxDocumentsClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoiceCorrectiveTaxDocuments/{id}": { "get": { "tags": [ "IssuedInvoiceCorrectiveTaxDocuments" ], "summary": "Gets Issued invoice corrective tax document by id.", "description": "Retrieves Issued invoice corrective tax document by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoiceCorrectiveTaxDocumentsIssuedInvoiceCorrectiveTaxDocumentsGroup+IssuedInvoiceCorrectiveTaxDocumentGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedInvoiceCorrectiveTaxDocumentDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedInvoiceCorrectiveTaxDocumentsClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoiceCorrectiveTaxDocuments/{id}/pdf": { "get": { "tags": [ "IssuedInvoiceCorrectiveTaxDocuments" ], "summary": "Issued invoice corrective tax document pdf by id.", "description": "Retrieves Issued invoice corrective tax document pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoiceCorrectiveTaxDocumentsIssuedInvoiceCorrectiveTaxDocumentsGroup+IssuedInvoiceCorrectiveTaxDocumentGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.IssuedInvoiceCorrectiveTaxDocumentsClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices": { "get": { "tags": [ "IssuedInvoices" ], "summary": "Issued invoices paginated.", "description": "Gets all Issued invoices by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+CzechIssuedInvoiceListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfIssuedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "IssuedInvoices" ], "summary": "Creates Issued invoice.", "description": "Creates Issued invoice by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+CzechCreateIssuedInvoicePostEndpoint", "requestBody": { "x-name": "CreateIssuedInvoiceDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIssuedInvoiceDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfIssuedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateIssuedInvoiceDto\r\n{\r\n Items = new List\r\n {\r\n new()\r\n {\r\n TextItem = new CreateIssuedInvoiceTextItemDto()\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/{DocumentId}/Liquidate/Standalone/Fully": { "post": { "tags": [ "IssuedInvoices" ], "summary": "Creates Liquidation.", "description": "Creates Liquidation by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+CreateFullIssuedInvoiceLiquidationPostEndpoint", "parameters": [ { "name": "DocumentId", "in": "path", "required": true, "description": "Issued invoice id.", "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "requestBody": { "x-name": "CreateFullIssuedInvoiceLiquidationDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFullIssuedInvoiceLiquidationDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfLiquidationDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateFullIssuedInvoiceLiquidationDto\r\n{\r\n DocumentId = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.Liquidate(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/{DocumentId}/Liquidate/Standalone/Partially": { "post": { "tags": [ "IssuedInvoices" ], "summary": "Creates Liquidation.", "description": "Creates Liquidation by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+CreatePartialIssuedInvoiceLiquidationPostEndpoint", "parameters": [ { "name": "DocumentId", "in": "path", "required": true, "description": "Issued invoice id.", "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "requestBody": { "x-name": "CreatePartialIssuedInvoiceLiquidationDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePartialIssuedInvoiceLiquidationDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfLiquidationDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreatePartialIssuedInvoiceLiquidationDto\r\n{\r\n DocumentId = Guid.Empty,\r\n DocumentCurrencyAmount = decimal.One\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.PartiallyLiquidate(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/{id}": { "get": { "tags": [ "IssuedInvoices" ], "summary": "Gets Issued invoice by id.", "description": "Retrieves Issued invoice by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+CzechIssuedInvoiceGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/{id}/isdoc": { "get": { "tags": [ "IssuedInvoices" ], "summary": "Issued invoice ISDOC by id.", "description": "Retrieves Issued invoice ISDOC.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+IssuedInvoiceGetIsdocEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.GetIsdoc(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/{id}/pdf": { "get": { "tags": [ "IssuedInvoices" ], "summary": "Issued invoice pdf by id.", "description": "Retrieves Issued invoice pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+IssuedInvoiceGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/{id}/RestToPay": { "get": { "tags": [ "IssuedInvoices" ], "summary": "Gets Document payment status by id.", "description": "Retrieves Document payment status by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+IssuedInvoiceRestToPayGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentPaymentStatusDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.GetRestToPay(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/Liquidation/{id}": { "get": { "tags": [ "IssuedInvoices" ], "summary": "Gets Liquidation by id.", "description": "Retrieves Liquidation by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+IssuedInvoiceLiquidationGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidationDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.GetLiquidation(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedInvoices/Unpaid": { "get": { "tags": [ "IssuedInvoices" ], "summary": "Document payment statuses paginated.", "description": "Gets all Document payment statuses by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesIssuedInvoicesIssuedInvoicesGroup+IssuedInvoiceUnpaidGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfDocumentPaymentStatusDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssuedInvoicesClient.GetAllUnpaidPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOffers": { "get": { "tags": [ "IssuedOffers" ], "summary": "Issued offers paginated.", "description": "Gets all Issued offers by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsOffersIssuedOffersIssuedOffersGroup+CzechIssuedOfferListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfIssuedOfferDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssuedOffersClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "IssuedOffers" ], "summary": "Creates Issued offer.", "description": "Creates Issued offer by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsOffersIssuedOffersIssuedOffersGroup+CzechCreateIssuedOfferPostEndpoint", "requestBody": { "x-name": "CreateIssuedOfferDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIssuedOfferDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfIssuedOfferDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateIssuedOfferDto\r\n{\r\n Items = new List\r\n {\r\n new()\r\n {\r\n TextItem = new CreateIssuedOfferTextItemDto()\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.IssuedOffersClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOffers/{id}": { "get": { "tags": [ "IssuedOffers" ], "summary": "Gets Issued offer by id.", "description": "Retrieves Issued offer by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsOffersIssuedOffersIssuedOffersGroup+CzechIssuedOfferGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedOfferDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedOffersClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOffers/{id}/pdf": { "get": { "tags": [ "IssuedOffers" ], "summary": "Issued offer pdf by id.", "description": "Retrieves Issued offer pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsOffersIssuedOffersIssuedOffersGroup+IssuedOfferGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.IssuedOffersClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOrders": { "get": { "tags": [ "IssuedOrders" ], "summary": "Issued orders paginated.", "description": "Gets all Issued orders by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersIssuedOrdersIssuedOrdersGroup+CzechIssuedOrderListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfIssuedOrderDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssuedOrdersClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "IssuedOrders" ], "summary": "Creates Issued order.", "description": "Creates Issued order by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersIssuedOrdersIssuedOrdersGroup+CzechCreateIssuedOrderPostEndpoint", "requestBody": { "x-name": "CreateIssuedOrderDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIssuedOrderDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfIssuedOrderDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateIssuedOrderDto\r\n{\r\n // business partner is mandatory!\r\n BusinessPartnerAddress = new DocumentAddressRequestWithoutDeliveryAddressDto\r\n {\r\n // link business partner from address book\r\n DocumentAddressWithAddressBookLink = new DocumentAddressWithAddressBookLinkDto\r\n {\r\n Id = Guid.Empty\r\n }\r\n // or without address book\r\n //DocumentAddressWithoutAddressBookLink = new DocumentAddressWithoutAddressBookLinkDto()\r\n //{\r\n // Name = \"test\",\r\n // City = \"test\"\r\n //}\r\n },\r\n Items = new List\r\n {\r\n new()\r\n {\r\n TextItem = new CreateIssuedOrderTextItemDto()\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.IssuedOrdersClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOrders/{id}": { "get": { "tags": [ "IssuedOrders" ], "summary": "Gets Issued order by id.", "description": "Retrieves Issued order by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersIssuedOrdersIssuedOrdersGroup+CzechIssuedOrderGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedOrderDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedOrdersClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOrders/{id}/pdf": { "get": { "tags": [ "IssuedOrders" ], "summary": "Issued order pdf by id.", "description": "Retrieves Issued order pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersIssuedOrdersIssuedOrdersGroup+IssuedOrderGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.IssuedOrdersClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOrders/{id}/status": { "get": { "tags": [ "IssuedOrders" ], "summary": "Gets Order status enum by id.", "description": "Retrieves Order status enum by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersIssuedOrdersIssuedOrdersGroup+IssuedOrderGetStatusEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusEnum" }, "example": "Unfinished" } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedOrdersClient.GetStatus(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssuedOrders/{id}/Transfer/ToReceivedInvoice/Fully": { "post": { "tags": [ "IssuedOrders" ], "summary": "Full transfer to Received invoice.", "description": "Fully transfers Issued order specified by id to new Received invoice.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersIssuedOrdersIssuedOrdersGroup+CzechIssuedOrderFullyTransferToReceivedInvoicePostEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfReceivedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new FullyTransferToReceivedInvoiceDto\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssuedOrdersClient.TransferFullyToReceivedInvoice(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssueSlips": { "get": { "tags": [ "IssueSlips" ], "summary": "Issue slips paginated.", "description": "Gets all Issue slips by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsStockMovementsIssueSlipsIssueSlipsGroup+CzechIssueSlipListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfIssueSlipDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.IssueSlipsClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "IssueSlips" ], "summary": "Creates Issue slip.", "description": "Creates Issue slip by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsStockMovementsIssueSlipsIssueSlipsGroup+CzechCreateIssueSlipPostEndpoint", "requestBody": { "x-name": "CreateIssueSlipDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIssueSlipDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfIssueSlipDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateIssueSlipDto\r\n{\r\n Items = new List\r\n {\r\n new()\r\n {\r\n TextItem = new CreateIssueSlipTextItemDto()\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.IssueSlipsClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssueSlips/{id}": { "get": { "tags": [ "IssueSlips" ], "summary": "Gets Issue slip by id.", "description": "Retrieves Issue slip by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsStockMovementsIssueSlipsIssueSlipsGroup+CzechIssueSlipGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueSlipDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.IssueSlipsClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/IssueSlips/{id}/pdf": { "get": { "tags": [ "IssueSlips" ], "summary": "Issue slip pdf by id.", "description": "Retrieves Issue slip pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsStockMovementsIssueSlipsIssueSlipsGroup+IssueSlipGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id.", "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "description": "Language.", "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.IssueSlipsClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PaymentMethods": { "get": { "tags": [ "PaymentMethods" ], "summary": "Payment methods paginated.", "description": "Gets all Payment methods by specified pagination.", "operationId": "MphOpenApiApiEndpointsListsPaymentMethodsPaymentMethodsGroup+PaymentMethodListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfPaymentMethodDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.PaymentMethodsClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "PaymentMethods" ], "summary": "Creates Payment method.", "description": "Creates Payment method by passed payload.", "operationId": "MphOpenApiApiEndpointsListsPaymentMethodsPaymentMethodsGroup+CzechCreatePaymentMethodPostEndpoint", "requestBody": { "x-name": "CreatePaymentMethodDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentMethodDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfPaymentMethodDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreatePaymentMethodDto\r\n{\r\n Name = \"test\"\r\n};\r\n\r\nvar response = await client.PaymentMethodsClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PaymentMethods/{id}": { "get": { "tags": [ "PaymentMethods" ], "summary": "Gets Payment method by id.", "description": "Retrieves Payment method by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsListsPaymentMethodsPaymentMethodsGroup+PaymentMethodGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.PaymentMethodsClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PaymentMethodTypes": { "get": { "tags": [ "PaymentMethodTypes" ], "summary": "Payment method types paginated.", "description": "Gets all Payment method types by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsPaymentMethodTypesPaymentMethodTypesGroup+PaymentMethodTypeListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfPaymentMethodTypeDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.PaymentMethodTypesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PaymentMethodTypes/{id}": { "get": { "tags": [ "PaymentMethodTypes" ], "summary": "Gets Payment method type by id.", "description": "Retrieves Payment method type by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsPaymentMethodTypesPaymentMethodTypesGroup+PaymentMethodTypeGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodTypeDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.PaymentMethodTypesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PriceListItems": { "get": { "tags": [ "PriceListItems" ], "summary": "Price list items paginated.", "description": "Gets all Price list items by specified pagination.", "operationId": "MphOpenApiApiEndpointsPriceListItemsPriceListItemsGroup+PriceListItemListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfPriceListItemDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.PriceListItemsClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PriceListItems/{id}": { "get": { "tags": [ "PriceListItems" ], "summary": "Gets Price list item by id.", "description": "Retrieves Price list item by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsPriceListItemsPriceListItemsGroup+PriceListItemGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListItemDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.PriceListItemsClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PriceListItems/{PriceListItemId}/RegistrationNumbers": { "get": { "tags": [ "PriceListItems" ], "summary": "Registration numbers paginated.", "description": "Gets all Registration numbers by specified pagination.", "operationId": "MphOpenApiApiEndpointsPriceListItemsPriceListItemsGroup+PriceListItemRegistrationNumbersGetEndpoint", "parameters": [ { "name": "PriceListItemId", "in": "path", "required": true, "description": "Price list item id.", "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfRegistrationNumberDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [] } }, "/v1/PriceListItems/AvailableQuantities": { "post": { "tags": [ "PriceListItems" ], "summary": "Price list item available quantity by ids.", "description": "Retrieves Price list item available quantities or information about parent entities by passed ids.", "operationId": "MphOpenApiApiEndpointsPriceListItemsPriceListItemsGroup+PriceListItemAvailableQuantityByIdListPostEndpoint", "requestBody": { "x-name": "ByIdListRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ByIdListRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListItemAvailableQuantityDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Ids' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdListRequest\r\n{\r\n Ids = new HashSet\r\n {\r\n Guid.Empty\r\n }\r\n};\r\n\r\nvar response = await client.PriceListItemsClient.GetPriceListItemAvailableQuantities(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/PriceListItems/SellingPrices": { "post": { "tags": [ "PriceListItems" ], "summary": "Price list item with selling prices by ids.", "description": "Retrieves Price list item with selling prices or information about parent entities by passed ids.", "operationId": "MphOpenApiApiEndpointsPriceListItemsPriceListItemsGroup+PriceListItemSellingPriceByIdListPostEndpoint", "requestBody": { "x-name": "ByIdListRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ByIdListRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListItemWithSellingPricesDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Ids' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdListRequest\r\n{\r\n Ids = new HashSet\r\n {\r\n Guid.Empty\r\n }\r\n};\r\n\r\nvar response = await client.PriceListItemsClient.GetPriceListItemSellingPrices(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedInvoices": { "get": { "tags": [ "ReceivedInvoices" ], "summary": "Received invoices paginated.", "description": "Gets all Received invoices by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesReceivedInvoicesReceivedInvoicesGroup+CzechReceivedInvoiceListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfReceivedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.ReceivedInvoicesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "ReceivedInvoices" ], "summary": "Creates Received invoice.", "description": "Creates Received invoice by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesReceivedInvoicesReceivedInvoicesGroup+CzechCreateReceivedInvoicePostEndpoint", "requestBody": { "x-name": "CreateReceivedInvoiceDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReceivedInvoiceDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfReceivedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateReceivedInvoiceDto\r\n{\r\n Items = new List\r\n {\r\n new()\r\n {\r\n TextItem = new CreateReceivedInvoiceTextItemDto()\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.ReceivedInvoicesClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedInvoices/{id}": { "get": { "tags": [ "ReceivedInvoices" ], "summary": "Gets Received invoice by id.", "description": "Retrieves Received invoice by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesReceivedInvoicesReceivedInvoicesGroup+CzechReceivedInvoiceGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.ReceivedInvoicesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedInvoices/{id}/pdf": { "get": { "tags": [ "ReceivedInvoices" ], "summary": "Received invoice pdf by id.", "description": "Retrieves Received invoice pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsInvoicesReceivedInvoicesReceivedInvoicesGroup+ReceivedInvoiceGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.ReceivedInvoicesClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedOrders": { "get": { "tags": [ "ReceivedOrders" ], "summary": "Received orders paginated.", "description": "Gets all Received orders by specified pagination.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersReceivedOrdersReceivedOrdersGroup+CzechReceivedOrderListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfReceivedOrderDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.ReceivedOrdersClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] }, "post": { "tags": [ "ReceivedOrders" ], "summary": "Creates Received order.", "description": "Creates Received order by passed payload.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersReceivedOrdersReceivedOrdersGroup+CzechCreateReceivedOrderPostEndpoint", "requestBody": { "x-name": "CreateReceivedOrderDto", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReceivedOrderDto" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfReceivedOrderDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new CreateReceivedOrderDto\r\n{\r\n // business partner is mandatory!\r\n BusinessPartnerAddress = new DocumentAddressRequestDto\r\n {\r\n // link business partner from address book\r\n DocumentAddressWithAddressBookLink = new DocumentAddressWithAddressBookLinkDto\r\n {\r\n Id = Guid.Empty\r\n }\r\n // or without address book\r\n //DocumentAddressWithoutAddressBookLink = new DocumentAddressWithoutAddressBookLinkDto()\r\n //{\r\n // Name = \"test\",\r\n // City = \"test\"\r\n //}\r\n },\r\n Items = new List\r\n {\r\n new()\r\n {\r\n TextItem = new CreateReceivedOrderTextItemDto()\r\n }\r\n }\r\n};\r\n\r\nvar response = await client.ReceivedOrdersClient.Create(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedOrders/{id}": { "get": { "tags": [ "ReceivedOrders" ], "summary": "Gets Received order by id.", "description": "Retrieves Received order by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersReceivedOrdersReceivedOrdersGroup+CzechReceivedOrderGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivedOrderDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.ReceivedOrdersClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedOrders/{id}/pdf": { "get": { "tags": [ "ReceivedOrders" ], "summary": "Received order pdf by id.", "description": "Retrieves Received order pdf by id in specified language.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersReceivedOrdersReceivedOrdersGroup+ReceivedOrderGetPdfEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } }, { "name": "Language", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/PdfLanguageEnum" } ] } } ], "responses": { "200": { "description": "Pdf file", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new PdfRequest\r\n{\r\n Id = Guid.Empty,\r\n Language = PdfLanguageEnum.English\r\n};\r\n\r\nvar response = await client.ReceivedOrdersClient.GetPdf(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n string path = Path.Combine(Path.GetTempPath(), response.ContentHeaders!.ContentDisposition!.FileName!);\r\n\r\n await using var file = File.Create(path);\r\n await using var content = response.Content!;\r\n\r\n await content.CopyToAsync(file, cancellationToken);\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedOrders/{id}/status": { "get": { "tags": [ "ReceivedOrders" ], "summary": "Gets Order status enum by id.", "description": "Retrieves Order status enum by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersReceivedOrdersReceivedOrdersGroup+ReceivedOrderGetStatusEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusEnum" }, "example": "Unfinished" } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.ReceivedOrdersClient.GetStatus(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/ReceivedOrders/{id}/Transfer/ToIssuedInvoice/Fully": { "post": { "tags": [ "ReceivedOrders" ], "summary": "Full transfer to Issued invoice.", "description": "Fully transfers Received order specified by id to new Issued invoice.", "operationId": "MphOpenApiApiEndpointsDocumentsOrdersReceivedOrdersReceivedOrdersGroup+CzechReceivedOrderFullyTransferToIssuedInvoicePostEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCreatedResponseDtoOfIssuedInvoiceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/400", "title": "Bad Request", "status": 400, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "Items": [ "'Items' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new FullyTransferToIssuedInvoiceDto\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.ReceivedOrdersClient.TransferFullyToIssuedInvoice(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Regions": { "get": { "tags": [ "Regions" ], "summary": "Regions paginated.", "description": "Gets all Regions by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsRegionsRegionsGroup+RegionListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfRegionDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.RegionsClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/Regions/{id}": { "get": { "tags": [ "Regions" ], "summary": "Gets Region by id.", "description": "Retrieves Region by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsRegionsRegionsGroup+RegionGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.RegionsClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/RegistrationNumbers": { "get": { "tags": [ "RegistrationNumbers" ], "summary": "Registration numbers paginated.", "description": "Gets all Registration numbers by specified pagination.", "operationId": "MphOpenApiApiEndpointsRegistrationNumbersRegistrationNumbersGroup+RegistrationNumberListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfRegistrationNumberDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.RegistrationNumbersClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/RegistrationNumbers/{id}": { "get": { "tags": [ "RegistrationNumbers" ], "summary": "Gets Registration number by id.", "description": "Retrieves Registration number by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsRegistrationNumbersRegistrationNumbersGroup+RegistrationNumberGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id.", "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationNumberDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.RegistrationNumbersClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/SellingPrices": { "get": { "tags": [ "SellingPrices" ], "summary": "Selling prices paginated.", "description": "Gets all Selling prices by specified pagination.", "operationId": "MphOpenApiApiEndpointsListsSellingPricesSellingPricesGroup+SellingPriceListGetEndpoint", "parameters": [ { "name": "After", "in": "query", "description": "Key set pagination after specified id.", "schema": { "type": "string", "nullable": true } }, { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfSellingPriceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetEntityListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.SellingPricesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/SellingPrices/{id}": { "get": { "tags": [ "SellingPrices" ], "summary": "Gets Selling price by id.", "description": "Retrieves Selling price by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsListsSellingPricesSellingPricesGroup+SellingPriceGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellingPriceDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.SellingPricesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/VatRates": { "get": { "tags": [ "VatRates" ], "summary": "Vat rates paginated.", "description": "Gets all Vat rates by specified pagination.", "operationId": "MphOpenApiApiEndpointsGeneralListsVatRatesVatRatesGroup+VatRateListGetEndpoint", "parameters": [ { "name": "PageSize", "in": "query", "required": true, "description": "Page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "required": true, "description": "Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ModifiedSince", "in": "query", "description": "Basic filter for modified since.", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityListQueryResultDtoOfVatRateDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "PageNumber": [ "'PageNumber' must be greater than '0'." ], "PageSize": [ "'PageSize' must be greater than '0'." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new GetGeneralListItemListQuery\r\n{\r\n PageNumber = 1,\r\n PageSize = 1,\r\n ModifiedSince = DateTime.Now.AddDays(-1)\r\n};\r\n\r\nvar response = await client.VatRatesClient.GetPaginated(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } }, "/v1/VatRates/{id}": { "get": { "tags": [ "VatRates" ], "summary": "Gets Vat rate by id.", "description": "Retrieves Vat rate by passed id, that cannot be empty.", "operationId": "MphOpenApiApiEndpointsGeneralListsVatRatesVatRatesGroup+VatRateGetEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VatRateDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/401", "title": "Unauthorized", "status": 401, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/403", "title": "Forbidden", "status": 403, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/429", "title": "Too Many Requests", "status": 429, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://httpstatuses.io/404", "title": "Not Found", "status": 404, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "errors": { "propertyName": [ "'Id' must not be empty." ] }, "type": "https://httpstatuses.io/422", "title": "Unprocessable Entity", "status": 422, "traceId": "00-775c67cbb830c73c55490d8b0b397f81-f4e8fd56f1c2f1cb-00" } } } } }, "security": [ { "ApiKeyAuth": [] }, { "oauth2": [] } ], "x-codeSamples": [ { "lang": "CSharp", "source": "var client = ClientProvider.CreateClient().WithApiKey(\"XYZ\").Build();\r\n\r\nvar request = new ByIdRequest\r\n{\r\n Id = Guid.Empty\r\n};\r\n\r\nvar response = await client.VatRatesClient.Get(request, cancellationToken);\r\n\r\nif (response.IsSuccessStatusCode)\r\n{\r\n //\r\n}\r\nelse\r\n{\r\n var error = response.AsProblemDetails();\r\n}" } ] } } }, "components": { "schemas": { "RegistrationNumberDto": { "type": "object", "description": "Registration number.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string", "description": "Name of registration number.", "nullable": true }, "AvailableQuantity": { "type": "number", "description": "Available quantity.", "format": "decimal" }, "ComplaintQuantity": { "type": "number", "description": "Complaint quantity.", "format": "decimal" }, "ServicedQuantity": { "type": "number", "description": "Serviced quantity.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "ModificationInfoDto": { "type": "object", "description": "Info about record modification.", "additionalProperties": false, "properties": { "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "CreatedBy": { "type": "string", "description": "Created by.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ModifiedDate": { "type": "string", "description": "Modified date.", "format": "date-time" }, "ModifiedBy": { "type": "string", "description": "Modified by.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "ProblemDetails": { "type": "object", "additionalProperties": { "nullable": true }, "properties": { "Type": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Status": { "type": "integer", "format": "int32", "nullable": true }, "Detail": { "type": "string", "nullable": true }, "Instance": { "type": "string", "nullable": true }, "Extensions": { "type": "object", "additionalProperties": {} } } }, "ValidationProblemDetails": { "type": "object", "additionalProperties": { "nullable": true }, "properties": { "Errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "Type": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Status": { "type": "integer", "format": "int32", "nullable": true }, "Detail": { "type": "string", "nullable": true }, "Instance": { "type": "string", "nullable": true }, "Extensions": { "type": "object", "additionalProperties": {} } } }, "EntityListQueryResultDtoOfRegistrationNumberDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/RegistrationNumberDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "PaginationInfoDto": { "type": "object", "description": "Pagination info.", "additionalProperties": false, "properties": { "PageNumber": { "type": "integer", "description": "Page number, starting from 1. Not filled when key set pagination was used.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "description": "Page size.", "format": "int32" }, "After": { "type": "string", "description": "Key set pagination after specified id.", "nullable": true } } }, "PriceListItemDto": { "type": "object", "description": "Price list item DTO.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Type": { "description": "Type.", "oneOf": [ { "$ref": "#/components/schemas/PriceListItemTypeEnum" } ] }, "RegistrationNumberType": { "description": "Registration number type.", "oneOf": [ { "$ref": "#/components/schemas/RegistrationNumberTypeEnum" } ] }, "Code": { "type": "string", "description": "Code.", "nullable": true }, "Name": { "type": "string", "description": "Name." }, "Plu": { "type": "integer", "description": "PLU.", "format": "int32", "nullable": true }, "Ean": { "type": "string", "description": "EAN.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "WarehouseDivisionPath": { "type": "string", "description": "Warehouse division path.", "nullable": true }, "WarehouseDivisionId": { "type": "string", "description": "Warehouse division id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "UnitQuantity": { "type": "number", "description": "Unit quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRate": { "description": "Vat rate.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "IsSales": { "type": "boolean", "description": "Is sales." }, "PriceGroup": { "type": "string", "description": "Price group.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "SubItems": { "type": "array", "description": "Sub items.", "items": { "$ref": "#/components/schemas/PriceListSubItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "PriceListItemTypeEnum": { "type": "string", "description": "Price list item type.

Enum member description:

Number value   String value   Description   Warning
1   Card   Card.   
2   Text   Text.    
3   Service   Service.   
4   Complete   Complete.   
5   Product   Product.   
6   Suite   Suite.   
", "x-enumNames": [ "Card", "Text", "Service", "Complete", "Product", "Suite" ], "enum": [ "Card", "Text", "Service", "Complete", "Product", "Suite" ] }, "RegistrationNumberTypeEnum": { "type": "string", "description": "Registration number type.

Enum member description:

Number value   String value   Description   Warning
0   None   None   
1   SerialNumber   Serial number   
2   Batch   Batch   
", "x-enumNames": [ "None", "SerialNumber", "Batch" ], "enum": [ "None", "SerialNumber", "Batch" ] }, "PriceVatTypeEnum": { "type": "string", "description": "Price type enum.

Enum member description:

Number value   String value   Description   Warning
0   WithoutVat   Price does not include VAT.   
1   WithVat   Price includes VAT.   
2   ReverseCharge   Reverse charge is applied (price is without VAT and VAT is not computed).\nUsed only in Czech version.   Used only in Czech version
", "x-enumNames": [ "WithoutVat", "WithVat", "ReverseCharge" ], "enum": [ "WithoutVat", "WithVat", "ReverseCharge" ] }, "VatRateTypeEnum": { "type": "string", "description": "Vat rate type.

Enum member description:

Number value   String value   Description   Warning
0   ZeroVatRate   Zero VAT rate.   
1   BasicVatRate   Basic VAT rate.   
2   FirstReducedVatRate   First reduced VAT rate.   
3   SecondReducedVatRate   Second reduced VAT rate.   
", "x-enumNames": [ "ZeroVatRate", "BasicVatRate", "FirstReducedVatRate", "SecondReducedVatRate" ], "enum": [ "ZeroVatRate", "BasicVatRate", "FirstReducedVatRate", "SecondReducedVatRate" ] }, "PriceListSubItemDto": { "type": "object", "description": "Price list sub item DTO.", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" } } }, "EntityListQueryResultDtoOfPriceListItemDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/PriceListItemDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "PriceListItemAvailableQuantityDto": { "type": "object", "description": "Price list item available quantity dto.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "EffectiveAvailableQuantity": { "type": "number", "description": "Effective available quantity.\nComputed like AvailableQuantity - ReservedQuantity - ComplaintQuantity.", "format": "decimal" }, "AvailableQuantity": { "type": "number", "description": "Available quantity.", "format": "decimal" }, "ReservedQuantity": { "type": "number", "description": "Reserved quantity.", "format": "decimal" }, "ComplaintQuantity": { "type": "number", "description": "Complaint quantity.", "format": "decimal" }, "ReceivedOrderQuantity": { "type": "number", "description": "Received order quantity.", "format": "decimal" } } }, "ByIdListRequest": { "type": "object", "description": "By id list request.", "additionalProperties": false, "required": [ "Ids" ], "properties": { "Ids": { "type": "array", "description": "Ids.", "minLength": 1, "nullable": false, "items": { "type": "string", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } } }, "PriceListItemWithSellingPricesDto": { "type": "object", "description": "Price list item with selling prices dto.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "SellingPrices": { "type": "array", "description": "Selling prices.", "items": { "$ref": "#/components/schemas/PriceListItemSellingPriceDto" } } } }, "PriceListItemSellingPriceDto": { "type": "object", "description": "Selling price of price list item or price list sub item.", "additionalProperties": false, "properties": { "SellingPriceName": { "type": "string", "description": "Selling price name." }, "Price": { "type": "number", "description": "Price.", "format": "decimal" }, "SellingPriceId": { "type": "string", "description": "Selling price id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "SellingPriceDto": { "type": "object", "description": "Selling price.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name.", "nullable": true }, "SellingPriceType": { "description": "Selling price type.", "oneOf": [ { "$ref": "#/components/schemas/SellingPriceTypeEnum" } ] }, "ValidityType": { "description": "Validity type.", "oneOf": [ { "$ref": "#/components/schemas/SellingPriceValidityTypeEnum" } ] }, "ValidFrom": { "type": "string", "description": "Valid from.", "format": "date-time", "nullable": true }, "ValidTo": { "type": "string", "description": "Valid to.", "format": "date-time", "nullable": true }, "Margin": { "type": "number", "description": "Margin.", "format": "decimal", "nullable": true }, "Rebate": { "type": "number", "description": "Rebate.", "format": "decimal", "nullable": true }, "Discount": { "type": "number", "description": "Discount.", "format": "decimal", "nullable": true }, "PriceVatType": { "description": "Price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Rounding": { "type": "number", "description": "Rounding.", "format": "decimal", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "SellingPriceTypeEnum": { "type": "string", "description": "Selling price type.

Enum member description:

Number value   String value   Description   Warning
0   BasicPrice   Basic price.   
1   SecondaryPrice   Secondary price.   
2   Discount   Discount.   
", "x-enumNames": [ "BasicPrice", "SecondaryPrice", "Discount" ], "enum": [ "BasicPrice", "SecondaryPrice", "Discount" ] }, "SellingPriceValidityTypeEnum": { "type": "string", "description": "Selling price validity type.

Enum member description:

Number value   String value   Description   Warning
0   Permanent   Permanent.   
1   TimeLimited   Time limited.   
2   Suspended   Suspended.   
", "x-enumNames": [ "Permanent", "TimeLimited", "Suspended" ], "enum": [ "Permanent", "TimeLimited", "Suspended" ] }, "EntityListQueryResultDtoOfSellingPriceDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/SellingPriceDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "PaymentMethodDto": { "type": "object", "description": "Payment method DTO.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string", "description": "Name." }, "Description": { "type": "string", "description": "Description.", "nullable": true }, "PaymentMethodTypeId": { "type": "string", "description": "Payment method type id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IsUsedInSaleVoucher": { "type": "boolean", "description": "Is used in sale voucher." }, "IsUsedInOtherAgendas": { "type": "boolean", "description": "Is used in other agendas." }, "IsIncludedInEet": { "type": "boolean", "description": "Is included in EET." }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "CurrencyRate": { "type": "number", "description": "Currency rate.", "format": "decimal", "nullable": true }, "CurrencyQuantity": { "type": "integer", "description": "Currency quantity.", "format": "int32", "nullable": true }, "TicketValue": { "type": "number", "description": "Ticket value.", "format": "decimal", "nullable": true }, "AdditionalTextForPrint": { "type": "string", "description": "Information in printed documents", "nullable": true }, "AdditionalEnglishTextForPrint": { "type": "string", "description": "Information in printed documents in English", "nullable": true }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityListQueryResultDtoOfPaymentMethodDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/PaymentMethodDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfPaymentMethodDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "WarningDto": { "type": "object", "description": "Warning info.", "additionalProperties": false, "properties": { "Code": { "description": "Warning code.", "oneOf": [ { "$ref": "#/components/schemas/WarningCodeEnum" } ] }, "Message": { "type": "string", "description": "Warning message." } } }, "WarningCodeEnum": { "type": "string", "description": "Warning codes.

Enum member description:

Number value   String value   Description   Warning
0   None   No warning.   
1   Unspecified   Unspecified warning (code). Warning is described only by message.   
2   SellingPriceCodeDoesNotExist   Selling price code specified in request does not exist.   
3   BusinessPartnerDoesNotExistAnyMore   Business partner specified in request no longer exists.   
4   BusinessPartnerDeliveryAddressDoesNotExistAnyMore   Business partner delivery address specified in request no longer exists.   
5   DocumentInHomeCurrencyCanNotHaveFilledExchangeRate   Document in home currency can not have filled exchange rate.   
6   DocumentInForeignCurrencyCanNotHaveRounding   Document in foreign currency can not have rounding.   
", "x-enumNames": [ "None", "Unspecified", "SellingPriceCodeDoesNotExist", "BusinessPartnerDoesNotExistAnyMore", "BusinessPartnerDeliveryAddressDoesNotExistAnyMore", "DocumentInHomeCurrencyCanNotHaveFilledExchangeRate", "DocumentInForeignCurrencyCanNotHaveRounding" ], "enum": [ "None", "Unspecified", "SellingPriceCodeDoesNotExist", "BusinessPartnerDoesNotExistAnyMore", "BusinessPartnerDeliveryAddressDoesNotExistAnyMore", "DocumentInHomeCurrencyCanNotHaveFilledExchangeRate", "DocumentInForeignCurrencyCanNotHaveRounding" ] }, "CreatePaymentMethodDto": { "type": "object", "description": "Create payment method.", "additionalProperties": false, "required": [ "Name" ], "properties": { "Name": { "type": "string", "description": "Name.", "maxLength": 32, "minLength": 0, "nullable": false }, "Description": { "type": "string", "description": "Description.", "maxLength": 255, "minLength": 0, "nullable": true }, "PaymentMethodTypeId": { "type": "string", "description": "Payment method type id. If not filled, cash will be used.", "format": "guid", "nullable": true }, "IsUsedInSaleVoucher": { "type": "boolean", "description": "Is used in sale voucher." }, "IsUsedInOtherAgendas": { "type": "boolean", "description": "Is used in other agendas." }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "nullable": true }, "TicketValue": { "type": "number", "description": "Ticket value.", "format": "decimal", "maximum": 1000.0, "minimum": 0.0, "nullable": true, "exclusiveMinimum": true }, "AdditionalTextForPrint": { "type": "string", "description": "Information in printed documents", "maxLength": 60, "minLength": 0, "nullable": true }, "AdditionalEnglishTextForPrint": { "type": "string", "description": "Information in printed documents in English", "maxLength": 60, "minLength": 0, "nullable": true } } }, "EstablishmentDto": { "type": "object", "description": "Establishment DTO.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "Street": { "type": "string", "description": "Street.", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "MobilePhoneNumber": { "type": "string", "description": "Mobile phone number.", "nullable": true }, "FaxNumber": { "type": "string", "description": "Fax number.", "nullable": true }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityListQueryResultDtoOfEstablishmentDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/EstablishmentDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "CentreDto": { "type": "object", "description": "Centre DTO.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "EstablishmentId": { "type": "string", "description": "Establishment id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityListQueryResultDtoOfCentreDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/CentreDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "CashRegisterDto": { "type": "object", "description": "Cash register DTO.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "CancellationDate": { "type": "string", "description": "Cancellation date.", "format": "date-time", "nullable": true }, "IsActive": { "type": "boolean", "description": "Is active." }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityListQueryResultDtoOfCashRegisterDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/CashRegisterDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "BankAccountDto": { "type": "object", "description": "Bank account.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "AccountName": { "type": "string", "description": "Account name." }, "AccountNumber": { "type": "string", "description": "Account number." }, "BankCode": { "type": "string", "description": "Bank code.", "nullable": true }, "Iban": { "type": "string", "description": "IBAN.", "nullable": true }, "Swift": { "type": "string", "description": "SWIFT.", "nullable": true }, "BankName": { "type": "string", "description": "Bank name.", "nullable": true }, "CancellationDate": { "type": "string", "description": "Cancellation date.", "format": "date-time", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "IsActive": { "type": "boolean", "description": "Is active." }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityListQueryResultDtoOfBankAccountDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/BankAccountDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "ActivityDto": { "type": "object", "description": "Activity DTO.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityListQueryResultDtoOfActivityDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/ActivityDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "VatRateDto": { "type": "object", "description": "VAT rate.", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "ValidFrom": { "type": "string", "description": "Valid from.", "format": "date-time", "nullable": true }, "ValidTo": { "type": "string", "description": "Valid to.", "format": "date-time", "nullable": true }, "VatPercent": { "type": "number", "description": "Vat percent.", "format": "decimal" }, "VatCoefficient": { "type": "number", "description": "Vat coefficient.", "format": "decimal" } } }, "GeneralListItemModificationInfoDto": { "type": "object", "description": "Genera list item modification info DTO.", "additionalProperties": false, "properties": { "ModifiedDate": { "type": "string", "description": "Modified date.", "format": "date-time" } } }, "EntityListQueryResultDtoOfVatRateDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/VatRateDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "RegionDto": { "type": "object", "description": "Region.", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." } } }, "EntityListQueryResultDtoOfRegionDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/RegionDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "PaymentMethodTypeDto": { "type": "object", "description": "Payment method type DTO.", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "Description": { "type": "string", "description": "Description." } } }, "EntityListQueryResultDtoOfPaymentMethodTypeDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/PaymentMethodTypeDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "ExchangeRateSetDto": { "type": "object", "description": "Exchange rate set (exchange rates for all currencies in one day).", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Date": { "type": "string", "description": "Date.", "format": "date-time" }, "ExchangeRates": { "type": "array", "description": "Exchange rates.", "items": { "$ref": "#/components/schemas/ExchangeRateDto" } } } }, "ExchangeRateDto": { "type": "object", "description": "Exchange rate (exchange rate value for specific currency).", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Rate": { "type": "number", "description": "Rate.", "format": "decimal" }, "Quantity": { "type": "integer", "description": "Quantity.", "format": "int32" } } }, "EntityListQueryResultDtoOfExchangeRateSetDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/ExchangeRateSetDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "CurrencyDto": { "type": "object", "description": "Currency DTO.", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "Symbol": { "type": "string", "description": "Symbol." } } }, "EntityListQueryResultDtoOfCurrencyDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/CurrencyDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "CountryDto": { "type": "object", "description": "Country DTO.", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "NumericCode": { "type": "integer", "description": "Numeric code.", "format": "int32" } } }, "EntityListQueryResultDtoOfCountryDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/CountryDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "CityPostCodeDto": { "type": "object", "description": "City post code DTO.", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "City": { "type": "string", "description": "City." }, "PostCode": { "type": "string", "description": "Post code." }, "PostName": { "type": "string", "description": "Post name." } } }, "EntityListQueryResultDtoOfCityPostCodeDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/CityPostCodeDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "BankDto": { "type": "object", "description": "Bank DTO.", "additionalProperties": false, "properties": { "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/GeneralListItemModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Code": { "type": "string", "description": "Code." }, "Name": { "type": "string", "description": "Name." }, "Swift": { "type": "string", "description": "Swift." }, "Web": { "type": "string", "description": "Web." }, "CountryId": { "type": "string", "description": "Country guid.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityListQueryResultDtoOfBankDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/BankDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "IssueSlipDto": { "type": "object", "additionalProperties": false, "properties": { "Status": { "description": "Status.", "oneOf": [ { "$ref": "#/components/schemas/IssueSlipStatusEnum" } ] }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/IssueSlipItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IsReverseCharge": { "type": "boolean", "description": "Flag specifying whether document has reverse charge." } } }, "PdfLanguageEnum": { "type": "string", "description": "Pdf language.

Enum member description:

Number value   String value   Description   Warning
0   Current   Represents current culture.   
1   English   English.   
", "x-enumNames": [ "Current", "English" ], "enum": [ "Current", "English" ] }, "IssueSlipStatusEnum": { "type": "string", "description": "Issue slip status.

Enum member description:

Number value   String value   Description   Warning
0   Unfinished   Unfinished.   
1   PartiallyFinished   Partially finished.   
2   Finished   Finished.   
", "x-enumNames": [ "Unfinished", "PartiallyFinished", "Finished" ], "enum": [ "Unfinished", "PartiallyFinished", "Finished" ] }, "DocumentAddressDto": { "type": "object", "description": "Document address.", "additionalProperties": false, "properties": { "DeliveryAddress": { "description": "Delivery address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentDeliveryAddressDto" } ] }, "BusinessPartnerId": { "type": "string", "description": "Business partner id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "IdentificationNumber": { "type": "string", "description": "Identification number.", "nullable": true }, "TaxIdentificationNumber": { "type": "string", "description": "Tax identification number.", "nullable": true }, "CompanyName": { "type": "string", "description": "Company name,", "nullable": true }, "Name": { "type": "string", "description": "Name.", "nullable": true }, "Street": { "type": "string", "description": "Street.", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "MobilePhoneNumber": { "type": "string", "description": "Mobile phone number.", "nullable": true }, "FaxNumber": { "type": "string", "description": "Fax number.", "nullable": true } } }, "DocumentDeliveryAddressDto": { "type": "object", "description": "Document delivery address.", "additionalProperties": false, "properties": { "DeliveryAddressId": { "type": "string", "description": "Delivery address id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "CompanyName": { "type": "string", "description": "Company name.", "nullable": true }, "Name": { "type": "string", "description": "Name.", "nullable": true }, "Street": { "type": "string", "description": "Street.", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true } } }, "IssueSlipItemDto": { "type": "object", "description": "Issue slip item.", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ReceivedOrderItemId": { "type": "string", "description": "Received order item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "TransferredQuantity": { "type": "number", "description": "Transferred quantity.", "format": "decimal", "nullable": true }, "RegistrationNumberId": { "type": "string", "description": "Registration number id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true } } }, "DocumentRecapitulationDto": { "type": "object", "description": "Document recapitulation.", "additionalProperties": false, "properties": { "TotalPrice": { "type": "number", "description": "Total price.", "format": "decimal" }, "ForeignCurrencyTotalPriceWithoutRounding": { "type": "number", "description": "Total price without rounding in foreign currency. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyTotalPrice": { "type": "number", "description": "Total price in foreign currency. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyRoundingAmount": { "type": "number", "description": "Rounding amount in foreign currency. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "VatRateSums": { "type": "array", "description": "VAT rate sums.", "items": { "$ref": "#/components/schemas/DocumentVatRateSumDto" } } } }, "VatRoundingTypeEnum": { "type": "string", "description": "VAT rounding type.

Enum member description:

Number value   String value   Description   Warning
0   None   Do not round.   
4   NoneEveryRate   Do not round every rate.   
", "x-enumNames": [ "None", "NoneEveryRate" ], "enum": [ "None", "NoneEveryRate" ] }, "DocumentRoundingTypeEnum": { "type": "string", "description": "Document rounding type.

Enum member description:

Number value   String value   Description   Warning
0   None   Do not round.   
1   MathToOne   Round mathematically to whole number.   
2   MathToHalf   Round mathematically to 50h/50 cents.\nUsed only in Slovak version.\nUsed only in Slovak version   
3   MathToTenth   Round mathematically to 10h/10 cents.\nUsed only in Slovak version.\nUsed only in Slovak version   
4   UpToOne   Round up to whole number.   
5   UpToHalf   Round up to 50h/50 cents.\nUsed only in Slovak version.\nUsed only in Slovak version   
6   UpToTenth   Round up to 10h/10 cents.\nUsed only in Slovak version.\nUsed only in Slovak version   
7   DownToOne   Round down to whole number.   
8   DownToHalf   Round down to 50h/50 cents.\nUsed only in Slovak version.\nUsed only in Slovak version   
9   DownToTenth   Round down to 10h/10 cents.\nUsed only in Slovak version.\nUsed only in Slovak version   
10   MathFiveCent   Round mathematically to 5 cents.\nUsed only in Slovak version.\nUsed only in Slovak version   
", "x-enumNames": [ "None", "MathToOne", "MathToHalf", "MathToTenth", "UpToOne", "UpToHalf", "UpToTenth", "DownToOne", "DownToHalf", "DownToTenth", "MathFiveCent" ], "enum": [ "None", "MathToOne", "MathToHalf", "MathToTenth", "UpToOne", "UpToHalf", "UpToTenth", "DownToOne", "DownToHalf", "DownToTenth", "MathFiveCent" ] }, "DocumentVatRateSumDto": { "type": "object", "description": "VAT rate sum.", "additionalProperties": false, "properties": { "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "TotalPrice": { "type": "number", "description": "Total price (price including VAT).", "format": "decimal" }, "VatRateType": { "description": "VAT rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] } } }, "EntityListQueryResultDtoOfIssueSlipDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/IssueSlipDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfIssueSlipDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssueSlipDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "CreateIssueSlipDto": { "type": "object", "additionalProperties": false, "required": [ "Items" ], "properties": { "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true }, "Status": { "description": "Status.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssueSlipStatusEnum" } ] }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled.\nIf not specified defaults to true.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id. If not filled, home currency will be used.", "format": "guid", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate. If filled and home currency is used, warning will be issued.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity. If filled and home currency is used, warning will be issued.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressRequestDto" } ] }, "Items": { "type": "array", "description": "Items.", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CreateIssueSlipItemDto" } } } }, "DocumentAddressRequestDto": { "type": "object", "additionalProperties": false, "properties": { "DeliveryAddress": { "description": "Delivery address.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentDeliveryAddressRequestDto" } ] }, "DocumentAddressWithAddressBookLink": { "description": "Document address with address book link.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressWithAddressBookLinkDto" } ] }, "DocumentAddressWithoutAddressBookLink": { "description": "Document address without address book link.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressWithoutAddressBookLinkDto" } ] } } }, "DocumentDeliveryAddressRequestDto": { "type": "object", "description": "Document delivery address request.", "additionalProperties": false, "properties": { "DeliveryAddressWithAddressBookLink": { "description": "Delivery address with address book link.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeliveryAddressWithAddressBookLinkDto" } ] }, "DeliveryAddressWithoutAddressBookLink": { "description": "Delivery address without address book link.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeliveryAddressWithoutAddressBookLinkDto" } ] } } }, "DeliveryAddressWithAddressBookLinkDto": { "type": "object", "description": "Delivery address with address book link.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Delivery address id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "DeliveryAddressWithoutAddressBookLinkDto": { "type": "object", "description": "Delivery address without address book link.", "additionalProperties": false, "properties": { "CompanyName": { "type": "string", "description": "Company name.", "nullable": true }, "Name": { "type": "string", "description": "Name. ", "nullable": true }, "Street": { "type": "string", "description": "Street. ", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true } } }, "DocumentAddressWithAddressBookLinkDto": { "type": "object", "description": "Document address with address book link.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Business partner id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "DocumentAddressWithoutAddressBookLinkDto": { "type": "object", "description": "Document address without address book link.", "additionalProperties": false, "properties": { "IdentificationNumber": { "type": "string", "description": "Identification number. ", "nullable": true }, "TaxIdentificationNumber": { "type": "string", "description": "Tax identification number.", "nullable": true }, "CompanyName": { "type": "string", "description": "Company name.", "nullable": true }, "Name": { "type": "string", "description": "Name.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "Street": { "type": "string", "description": "Street.", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "MobilePhoneNumber": { "type": "string", "description": "Mobile phone number.", "nullable": true }, "FaxNumber": { "type": "string", "description": "Fax number.", "nullable": true } } }, "CreateIssueSlipItemDto": { "type": "object", "description": "Create issue slip item.", "additionalProperties": false, "properties": { "TextItem": { "description": "Item data used in case of text item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssueSlipTextItemDto" } ] }, "PriceListItem": { "description": "Item data used in case of price list item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssueSlipPriceListItemDto" } ] } } }, "CreateIssueSlipTextItemDto": { "type": "object", "description": "Create issue slip text item.", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "VatRateType": { "description": "VAT rate type.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateIssueSlipPriceListItemDto": { "type": "object", "description": "Create issue slip price list item.", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberId": { "type": "string", "description": "Id of registration number.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPriceVatType": { "description": "Unit price type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRateType": { "description": "Vat rate type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "DiscountPercentage": { "type": "number", "description": "Discount percentage. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "OrderStatusEnum": { "type": "string", "description": "Order status.

Enum member description:

Number value   String value   Description   Warning
0   Unfinished   Unfinished order.   
1   PartiallyFinished   Partially finished order.   
2   Finished   Finished order.   
3   PermanentDocument   Permanent document.   
", "x-enumNames": [ "Unfinished", "PartiallyFinished", "Finished", "PermanentDocument" ], "enum": [ "Unfinished", "PartiallyFinished", "Finished", "PermanentDocument" ] }, "ReceivedOrderDto": { "type": "object", "additionalProperties": false, "properties": { "ExecuteFromDate": { "type": "string", "description": "Execute from date.", "format": "date-time", "nullable": true }, "ExecuteToDate": { "type": "string", "description": "Execute to date.", "format": "date-time", "nullable": true }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "IsReserved": { "type": "boolean", "description": "Is reserved." }, "Status": { "description": "Status.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrderStatusEnum" } ] }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/ReceivedOrderItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IsReverseCharge": { "type": "boolean", "description": "Flag specifying whether document has reverse charge." } } }, "ReceivedOrderItemDto": { "type": "object", "description": "Received order item.", "additionalProperties": false, "properties": { "DeliveredQuantity": { "type": "number", "description": "Delivered quantity.", "format": "decimal", "nullable": true }, "RegistrationNumberId": { "type": "string", "description": "Registration number id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IssuedOfferItemGuid": { "type": "string", "description": "Issued offer item guid.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityListQueryResultDtoOfReceivedOrderDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/ReceivedOrderDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfReceivedOrderDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceivedOrderDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "CreateReceivedOrderDto": { "type": "object", "additionalProperties": false, "required": [ "BusinessPartnerAddress", "Items" ], "properties": { "ExecuteFromDate": { "type": "string", "description": "Execute from date.", "format": "date-time", "nullable": true }, "ExecuteToDate": { "type": "string", "description": "Execute to date.", "format": "date-time", "nullable": true }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "Status": { "description": "Status.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrderStatusEnum" } ] }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled.\nIf not specified defaults to true.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id. If not filled, home currency will be used.", "format": "guid", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate. If filled and home currency is used, warning will be issued.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity. If filled and home currency is used, warning will be issued.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "BusinessPartnerAddress": { "description": "Business partner address.", "nullable": false, "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressRequestDto" } ] }, "Items": { "type": "array", "description": "Items.", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CreateReceivedOrderItemDto" } } } }, "CreateReceivedOrderItemDto": { "type": "object", "additionalProperties": false, "properties": { "TextItem": { "description": "Item data used in case of text item.", "oneOf": [ { "$ref": "#/components/schemas/CreateReceivedOrderTextItemDto" } ] }, "PriceListItem": { "description": "Item data used in case of price list item.", "oneOf": [ { "$ref": "#/components/schemas/CreateReceivedOrderPriceListItemDto" } ] } } }, "CreateReceivedOrderTextItemDto": { "type": "object", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "VatRateType": { "description": "VAT rate type.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateReceivedOrderPriceListItemDto": { "type": "object", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberId": { "type": "string", "description": "Id of registration number.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPriceVatType": { "description": "Unit price type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRateType": { "description": "Vat rate type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "DiscountPercentage": { "type": "number", "description": "Discount percentage. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityCreatedResponseDtoOfIssuedInvoiceDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssuedInvoiceDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "IssuedInvoiceDto": { "type": "object", "additionalProperties": false, "properties": { "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "BankAccountId": { "type": "string", "description": "Bank account id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "CashRegisterId": { "type": "string", "description": "Cash register id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DueDate": { "type": "string", "description": "Due date.", "format": "date-time" }, "TaxDate": { "type": "string", "description": "Tax date.", "format": "date-time" }, "VariableSymbol": { "type": "string", "description": "Variable symbol." }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/IssuedInvoiceItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IsReverseCharge": { "type": "boolean", "description": "Flag specifying whether document has reverse charge." } } }, "IssuedInvoiceItemDto": { "type": "object", "description": "Issued invoice item.", "additionalProperties": false, "properties": { "RegistrationNumberId": { "type": "string", "description": "Registration number id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ReceivedOrderItemId": { "type": "string", "description": "Received order item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "IssuedOrderDto": { "type": "object", "additionalProperties": false, "properties": { "RequiredDeliveryDate": { "type": "string", "description": "Required delivery date.", "format": "date-time", "nullable": true }, "ActualDeliveryDate": { "type": "string", "description": "Actual delivery date.", "format": "date-time", "nullable": true }, "Status": { "description": "Status.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrderStatusEnum" } ] }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressWithoutDeliveryAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/IssuedOrderItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IsReverseCharge": { "type": "boolean", "description": "Flag specifying whether document has reverse charge." } } }, "DocumentAddressWithoutDeliveryAddressDto": { "type": "object", "additionalProperties": false, "properties": { "BusinessPartnerId": { "type": "string", "description": "Business partner id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "IdentificationNumber": { "type": "string", "description": "Identification number.", "nullable": true }, "TaxIdentificationNumber": { "type": "string", "description": "Tax identification number.", "nullable": true }, "CompanyName": { "type": "string", "description": "Company name,", "nullable": true }, "Name": { "type": "string", "description": "Name.", "nullable": true }, "Street": { "type": "string", "description": "Street.", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "MobilePhoneNumber": { "type": "string", "description": "Mobile phone number.", "nullable": true }, "FaxNumber": { "type": "string", "description": "Fax number.", "nullable": true } } }, "IssuedOrderItemDto": { "type": "object", "description": "Issued order item.", "additionalProperties": false, "properties": { "DeliveredQuantity": { "type": "number", "description": "Delivered quantity.", "format": "decimal", "nullable": true }, "RegistrationNumberId": { "type": "string", "description": "Registration number id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityListQueryResultDtoOfIssuedOrderDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/IssuedOrderDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfIssuedOrderDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssuedOrderDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "CreateIssuedOrderDto": { "type": "object", "additionalProperties": false, "required": [ "BusinessPartnerAddress", "Items" ], "properties": { "RequiredDeliveryDate": { "type": "string", "description": "Required delivery date.", "format": "date-time", "nullable": true }, "ActualDeliveryDate": { "type": "string", "description": "Actual delivery date.", "format": "date-time", "nullable": true }, "Status": { "description": "Status.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrderStatusEnum" } ] }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled.\nIf not specified defaults to true.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id. If not filled, home currency will be used.", "format": "guid", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate. If filled and home currency is used, warning will be issued.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity. If filled and home currency is used, warning will be issued.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "BusinessPartnerAddress": { "description": "Business partner address.", "nullable": false, "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressRequestWithoutDeliveryAddressDto" } ] }, "Items": { "type": "array", "description": "Items.", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CreateIssuedOrderItemDto" } } } }, "DocumentAddressRequestWithoutDeliveryAddressDto": { "type": "object", "additionalProperties": false, "properties": { "DocumentAddressWithAddressBookLink": { "description": "Document address with address book link.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressWithAddressBookLinkDto" } ] }, "DocumentAddressWithoutAddressBookLink": { "description": "Document address without address book link.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressWithoutAddressBookLinkDto" } ] } } }, "CreateIssuedOrderItemDto": { "type": "object", "additionalProperties": false, "properties": { "TextItem": { "description": "Item data used in case of text item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedOrderTextItemDto" } ] }, "PriceListItem": { "description": "Item data used in case of price list item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedOrderPriceListItemDto" } ] } } }, "CreateIssuedOrderTextItemDto": { "type": "object", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "VatRateType": { "description": "VAT rate type.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateIssuedOrderPriceListItemDto": { "type": "object", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberId": { "type": "string", "description": "Id of registration number.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPriceVatType": { "description": "Unit price type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRateType": { "description": "Vat rate type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "DiscountPercentage": { "type": "number", "description": "Discount percentage. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityCreatedResponseDtoOfReceivedInvoiceDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceivedInvoiceDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "ReceivedInvoiceDto": { "type": "object", "additionalProperties": false, "properties": { "SupplierInfo": { "description": "Supplier info.", "oneOf": [ { "$ref": "#/components/schemas/SupplierInfoDto" } ] }, "CashRegisterId": { "type": "string", "description": "Cash register id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DueDate": { "type": "string", "description": "Due date.", "format": "date-time" }, "TaxDate": { "type": "string", "description": "Tax date.", "format": "date-time" }, "VariableSymbol": { "type": "string", "description": "Variable symbol." }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressWithoutDeliveryAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/ReceivedInvoiceItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IsReverseCharge": { "type": "boolean", "description": "Flag specifying whether document has reverse charge." } } }, "SupplierInfoDto": { "type": "object", "description": "Supplier info.", "additionalProperties": false, "properties": { "BankAccountNumber": { "type": "string", "description": "Bank account number.", "nullable": true }, "BankCode": { "type": "string", "description": " Bank code.\n ", "nullable": true }, "MessageForRecipient": { "type": "string", "description": "Message for recipient.", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number.", "nullable": true } } }, "ReceivedInvoiceItemDto": { "type": "object", "description": "Received invoice item.", "additionalProperties": false, "properties": { "RegistrationNumberId": { "type": "string", "description": "Registration number id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IssuedOrderItemId": { "type": "string", "description": "Issued order item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "IssuedOfferDto": { "type": "object", "additionalProperties": false, "properties": { "ValidTo": { "type": "string", "description": "Valid to.", "format": "date-time", "nullable": true }, "Status": { "description": "Status.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssuedOfferStatusEnum" } ] }, "DetailText": { "type": "string", "description": "Text in details.", "nullable": true }, "DetailTextInEnglish": { "type": "string", "description": "Text in details in english.", "nullable": true }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/IssuedOfferItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IsReverseCharge": { "type": "boolean", "description": "Flag specifying whether document has reverse charge." } } }, "IssuedOfferStatusEnum": { "type": "string", "description": "Issued offer status.

Enum member description:

Number value   String value   Description   Warning
0   Unfinished   Unfinished.   
1   PartiallyFinished   Partially finished.   
2   Finished   Finished.   
3   PermanentDocument   Permanent document.   
4   SentForApproval   Sent for approval.   
5   Rejected   Rejected.   
", "x-enumNames": [ "Unfinished", "PartiallyFinished", "Finished", "PermanentDocument", "SentForApproval", "Rejected" ], "enum": [ "Unfinished", "PartiallyFinished", "Finished", "PermanentDocument", "SentForApproval", "Rejected" ] }, "IssuedOfferItemDto": { "type": "object", "description": "Issued offer item.", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "TransferredQuantity": { "type": "number", "description": "Transferred quantity.", "format": "decimal", "nullable": true }, "RegistrationNumberId": { "type": "string", "description": "Registration number id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true } } }, "EntityListQueryResultDtoOfIssuedOfferDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/IssuedOfferDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfIssuedOfferDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssuedOfferDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "CreateIssuedOfferDto": { "type": "object", "additionalProperties": false, "required": [ "Items" ], "properties": { "ValidTo": { "type": "string", "description": "Valid to.", "format": "date-time", "nullable": true }, "Status": { "description": "Status.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssuedOfferStatusEnum" } ] }, "DetailText": { "type": "string", "description": "Text in details.", "nullable": true }, "DetailTextInEnglish": { "type": "string", "description": "Text in details in english.", "nullable": true }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled.\nIf not specified defaults to true.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id. If not filled, home currency will be used.", "format": "guid", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate. If filled and home currency is used, warning will be issued.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity. If filled and home currency is used, warning will be issued.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressRequestDto" } ] }, "Items": { "type": "array", "description": "Items.", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CreateIssuedOfferItemDto" } } } }, "CreateIssuedOfferItemDto": { "type": "object", "description": "Create issued offer item.", "additionalProperties": false, "properties": { "TextItem": { "description": "Item data used in case of text item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedOfferTextItemDto" } ] }, "PriceListItem": { "description": "Item data used in case of price list item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedOfferPriceListItemDto" } ] } } }, "CreateIssuedOfferTextItemDto": { "type": "object", "description": "Create issued offer text item.", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "VatRateType": { "description": "VAT rate type.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateIssuedOfferPriceListItemDto": { "type": "object", "description": "Create issued offer price list item.", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberId": { "type": "string", "description": "Id of registration number.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPriceVatType": { "description": "Unit price type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRateType": { "description": "Vat rate type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "DiscountPercentage": { "type": "number", "description": "Discount percentage. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityListQueryResultDtoOfReceivedInvoiceDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/ReceivedInvoiceDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "CreateReceivedInvoiceDto": { "type": "object", "additionalProperties": false, "required": [ "Items" ], "properties": { "SupplierInfo": { "description": "Supplier info.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SupplierInfoDto" } ] }, "CashRegisterId": { "type": "string", "description": "Cash register id.", "format": "guid", "nullable": true }, "DueDate": { "type": "string", "description": "Due date.", "format": "date-time", "nullable": true }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "TaxDate": { "type": "string", "description": "Tax date.", "format": "date-time", "nullable": true }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true }, "VariableSymbol": { "type": "string", "description": "Variable symbol.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled.\nIf not specified defaults to true.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id. If not filled, home currency will be used.", "format": "guid", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate. If filled and home currency is used, warning will be issued.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity. If filled and home currency is used, warning will be issued.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressRequestWithoutDeliveryAddressDto" } ] }, "Items": { "type": "array", "description": "Items.", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CreateReceivedInvoiceItemDto" } } } }, "CreateReceivedInvoiceItemDto": { "type": "object", "additionalProperties": false, "properties": { "TextItem": { "description": "Item data used in case of text item.", "oneOf": [ { "$ref": "#/components/schemas/CreateReceivedInvoiceTextItemDto" } ] }, "PriceListItem": { "description": "Item data used in case of price list item.", "oneOf": [ { "$ref": "#/components/schemas/CreateReceivedInvoicePriceListItemDto" } ] } } }, "CreateReceivedInvoiceTextItemDto": { "type": "object", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "VatRateType": { "description": "VAT rate type.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateReceivedInvoicePriceListItemDto": { "type": "object", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberId": { "type": "string", "description": "Id of registration number.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPriceVatType": { "description": "Unit price type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRateType": { "description": "Vat rate type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "DiscountPercentage": { "type": "number", "description": "Discount percentage. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "DocumentPaymentStatusDto": { "type": "object", "description": "Document payment status.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Number": { "type": "string", "description": "Document number." }, "RestToPay": { "type": "number", "description": "To pay.", "format": "decimal" }, "LiquidationInfos": { "type": "array", "description": "Liquidation infos.", "items": { "$ref": "#/components/schemas/LiquidationInfoDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "LiquidationInfoDto": { "type": "object", "description": "Liquidation info dto.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Id", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "Date": { "type": "string", "description": "Liquidation date", "format": "date-time" }, "DocumentCurrencyAmount": { "type": "number", "description": "Amount in document currency. If document is in USD, this property should reflect that received amount is in USD", "format": "decimal" } } }, "EntityListQueryResultDtoOfDocumentPaymentStatusDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/DocumentPaymentStatusDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityListQueryResultDtoOfIssuedInvoiceDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/IssuedInvoiceDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "CreateIssuedInvoiceDto": { "type": "object", "additionalProperties": false, "required": [ "Items" ], "properties": { "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "BankAccountId": { "type": "string", "description": "Bank account id.", "format": "guid", "nullable": true }, "CashRegisterId": { "type": "string", "description": "Cash register id.", "format": "guid", "nullable": true }, "DueDate": { "type": "string", "description": "Due date.", "format": "date-time", "nullable": true }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "TaxDate": { "type": "string", "description": "Tax date.", "format": "date-time", "nullable": true }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true }, "VariableSymbol": { "type": "string", "description": "Variable symbol.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled.\nIf not specified defaults to true.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id. If not filled, home currency will be used.", "format": "guid", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate. If filled and home currency is used, warning will be issued.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity. If filled and home currency is used, warning will be issued.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressRequestDto" } ] }, "Items": { "type": "array", "description": "Items.", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CreateIssuedInvoiceItemDto" } } } }, "CreateIssuedInvoiceItemDto": { "type": "object", "additionalProperties": false, "properties": { "TextItem": { "description": "Item data used in case of text item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedInvoiceTextItemDto" } ] }, "PriceListItem": { "description": "Item data used in case of price list item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedInvoicePriceListItemDto" } ] } } }, "CreateIssuedInvoiceTextItemDto": { "type": "object", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "VatRateType": { "description": "VAT rate type.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateIssuedInvoicePriceListItemDto": { "type": "object", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberId": { "type": "string", "description": "Id of registration number.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPriceVatType": { "description": "Unit price type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRateType": { "description": "Vat rate type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "DiscountPercentage": { "type": "number", "description": "Discount percentage. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "LiquidationDto": { "type": "object", "description": "Liquidation.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IssuedInvoiceId": { "type": "string", "description": "Issued invoice id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "HomeCurrencyAmount": { "type": "number", "description": "Amount in home currency.", "format": "decimal" }, "DocumentCurrencyAmount": { "type": "number", "description": "Amount in document currency. If document is in USD, this property should reflect that received amount is in USD.", "format": "decimal" }, "Date": { "type": "string", "description": "Liquidation date.", "format": "date-time" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfLiquidationDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LiquidationDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "CreateFullIssuedInvoiceLiquidationDto": { "type": "object", "description": "Create full invoice liquidation.", "additionalProperties": false, "properties": { "Date": { "type": "string", "description": "Liquidation date.", "format": "date-time", "nullable": true }, "Note": { "type": "string", "description": "Note.", "maxLength": 64, "minLength": 0, "nullable": true } } }, "CreatePartialIssuedInvoiceLiquidationDto": { "type": "object", "description": "Create partial issued invoice liquidation.", "additionalProperties": false, "required": [ "DocumentCurrencyAmount" ], "properties": { "Date": { "type": "string", "description": "Liquidation date.", "format": "date-time", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "HomeCurrencyAmount": { "type": "number", "description": "Amount in home currency. Required for foreign currency documents.", "format": "decimal", "nullable": true }, "DocumentCurrencyAmount": { "type": "number", "description": "Amount in document currency. If document is in USD, this property should reflect that received amount is in USD. Always required.", "format": "decimal", "minLength": 1, "nullable": false } } }, "IssuedInvoiceCorrectiveTaxDocumentDto": { "type": "object", "additionalProperties": false, "properties": { "CorrectedDocumentId": { "type": "string", "description": "Id of corrected issued invoice.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "BankAccountId": { "type": "string", "description": "Bank account id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "CashRegisterId": { "type": "string", "description": "Cash register id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DueDate": { "type": "string", "description": "Due date.", "format": "date-time" }, "TaxDate": { "type": "string", "description": "Tax date.", "format": "date-time" }, "VariableSymbol": { "type": "string", "description": "Variable symbol." }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/IssuedInvoiceCorrectiveTaxDocumentItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "IssuedInvoiceCorrectiveTaxDocumentItemDto": { "type": "object", "additionalProperties": false, "properties": { "RegistrationNumberId": { "type": "string", "description": "Registration number id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityListQueryResultDtoOfIssuedInvoiceCorrectiveTaxDocumentDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/IssuedInvoiceCorrectiveTaxDocumentDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "IssuedAdvanceInvoiceDto": { "type": "object", "additionalProperties": false, "properties": { "DueDate": { "type": "string", "description": "Due date.", "format": "date-time" }, "VariableSymbol": { "type": "string", "description": "Variable symbol." }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "BankAccountId": { "type": "string", "description": "Bank account id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "CashRegisterId": { "type": "string", "description": "Cash register id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time" }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "ExchangeRate": { "type": "number", "description": "Exchange rate.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity.", "format": "int32", "nullable": true }, "DocumentNumber": { "type": "string", "description": "Document number." }, "Text": { "type": "string", "description": "Text." }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled." }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressDto" } ] }, "Items": { "type": "array", "description": "Document items.", "items": { "$ref": "#/components/schemas/IssuedAdvanceInvoiceItemDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "DocumentRecapitulation": { "description": "Document recapitulation.", "oneOf": [ { "$ref": "#/components/schemas/DocumentRecapitulationDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "IssuedAdvanceInvoiceItemDto": { "type": "object", "description": "Issued advance invoice item.", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "ForeignCurrencyUnitPrice": { "type": "number", "description": "Foreign currency unit price. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyWithoutVat": { "type": "number", "description": "Foreign currency without vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "ForeignCurrencyVat": { "type": "number", "description": "Foreign currency vat. Filled only if document is in foreign currency.", "format": "decimal", "nullable": true }, "VatRateType": { "description": "Vat rate type.", "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "VatRateId": { "type": "string", "description": "Vat rate id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "PriceWithoutVat": { "type": "number", "description": "Price without VAT.", "format": "decimal" }, "Vat": { "type": "number", "description": "VAT.", "format": "decimal" }, "PriceWithVat": { "type": "number", "description": "Price with VAT.", "format": "decimal" }, "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" } } }, "EntityListQueryResultDtoOfIssuedAdvanceInvoiceDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/IssuedAdvanceInvoiceDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfIssuedAdvanceInvoiceDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IssuedAdvanceInvoiceDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "CreateIssuedAdvanceInvoiceDto": { "type": "object", "additionalProperties": false, "required": [ "Items" ], "properties": { "DueDate": { "type": "string", "description": "Due date.", "format": "date-time", "nullable": true }, "PaymentMethodId": { "type": "string", "description": "Payment method id.", "format": "guid", "nullable": true }, "OrderNumber": { "type": "string", "description": "Order number.", "nullable": true }, "OrderDate": { "type": "string", "description": "Order date.", "format": "date-time", "nullable": true }, "BankAccountId": { "type": "string", "description": "Bank account id.", "format": "guid", "nullable": true }, "CashRegisterId": { "type": "string", "description": "Cash register id.", "format": "guid", "nullable": true }, "SellingPriceCode": { "type": "string", "description": "Selling price code.", "nullable": true }, "VariableSymbol": { "type": "string", "description": "Variable symbol.", "nullable": true }, "IsSynchronizationToPhEnabled": { "type": "boolean", "description": "Flag specifying whether document synchronization to POHODA is enabled.\nIf not specified defaults to true.", "nullable": true }, "IssueDate": { "type": "string", "description": "Issue date.", "format": "date-time", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "ContractNumber": { "type": "string", "description": "Contract number.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id. If not filled, home currency will be used.", "format": "guid", "nullable": true }, "ExchangeRate": { "type": "number", "description": "Exchange rate. If filled and home currency is used, warning will be issued.", "format": "decimal", "nullable": true }, "ExchangeRateQuantity": { "type": "integer", "description": "Exchange rate quantity. If filled and home currency is used, warning will be issued.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "VatRounding": { "description": "VAT rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRoundingTypeEnum" } ] }, "Rounding": { "description": "Document rounding.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentRoundingTypeEnum" } ] }, "BusinessPartnerAddress": { "description": "Business partner address.", "oneOf": [ { "$ref": "#/components/schemas/DocumentAddressRequestDto" } ] }, "Items": { "type": "array", "description": "Items.", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CreateIssuedAdvanceInvoiceItemDto" } } } }, "CreateIssuedAdvanceInvoiceItemDto": { "type": "object", "description": "Create issued advance invoice item.", "additionalProperties": false, "properties": { "TextItem": { "description": "Item data used in case of text item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedAdvanceInvoiceTextItemDto" } ] }, "PriceListItem": { "description": "Item data used in case of price list item.", "oneOf": [ { "$ref": "#/components/schemas/CreateIssuedAdvanceInvoicePriceListItemDto" } ] } } }, "CreateIssuedAdvanceInvoiceTextItemDto": { "type": "object", "description": "Create issued advance invoice text item.", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code.", "nullable": true }, "Text": { "type": "string", "description": "Text.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity.", "format": "decimal" }, "UnitPrice": { "type": "number", "description": "Unit price.", "format": "decimal" }, "UnitPriceVatType": { "description": "Unit price type.", "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "Unit": { "type": "string", "description": "Unit.", "nullable": true }, "VatRateType": { "description": "VAT rate type.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "DiscountPercentage": { "type": "number", "description": "Discount percentage.", "format": "decimal" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateIssuedAdvanceInvoicePriceListItemDto": { "type": "object", "description": "Create issued advance invoice price list item.", "additionalProperties": false, "properties": { "PriceListItemId": { "type": "string", "description": "Price list item id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberId": { "type": "string", "description": "Id of registration number.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "RegistrationNumberName": { "type": "string", "description": "Registration number name.", "nullable": true }, "Quantity": { "type": "number", "description": "Quantity. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPrice": { "type": "number", "description": "Unit price. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "UnitPriceVatType": { "description": "Unit price type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PriceVatTypeEnum" } ] }, "VatRateType": { "description": "Vat rate type. When not filled, quantity from price list item is used. Ignored for complete or suite.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VatRateTypeEnum" } ] }, "DiscountPercentage": { "type": "number", "description": "Discount percentage. When not filled, quantity from price list item is used. Ignored for complete or suite.", "format": "decimal", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateFullIssuedAdvanceInvoiceLiquidationDto": { "type": "object", "description": "Create full invoice liquidation.", "additionalProperties": false, "properties": { "Date": { "type": "string", "description": "Liquidation date.", "format": "date-time", "nullable": true }, "Note": { "type": "string", "description": "Note.", "maxLength": 64, "minLength": 0, "nullable": true } } }, "BusinessPartnerDto": { "type": "object", "description": "Business partner.", "additionalProperties": false, "properties": { "IdentificationNumber": { "type": "string", "description": "Identification number. ", "nullable": true }, "TaxIdentificationNumber": { "type": "string", "description": "Tax identification number.", "nullable": true }, "CompanyName": { "type": "string", "description": "Company name.", "nullable": true }, "Name": { "type": "string", "description": "Name.", "nullable": true }, "Street": { "type": "string", "description": "Street.", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "MobilePhoneNumber": { "type": "string", "description": "Mobile phone number.", "nullable": true }, "FaxNumber": { "type": "string", "description": "Fax number.", "nullable": true }, "Web": { "type": "string", "description": "Web.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "BusinessDetails": { "description": "Business details.", "oneOf": [ { "$ref": "#/components/schemas/BusinessPartnerBusinessDetailsDto" } ] }, "AdditionalDetails": { "description": "Additional details.", "oneOf": [ { "$ref": "#/components/schemas/BusinessPartnerAdditionalDetailsDto" } ] }, "DeliveryAddresses": { "type": "array", "description": "Delivery addresses.", "items": { "$ref": "#/components/schemas/BusinessPartnerDeliveryAddressDto" } }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] }, "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "RegionId": { "type": "string", "description": "Region.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "BusinessPartnerBusinessDetailsDto": { "type": "object", "description": "Business partner business details.", "additionalProperties": false, "properties": { "Number": { "type": "string", "description": "Number.", "nullable": true }, "Contract": { "type": "string", "description": "Contract.", "nullable": true }, "DuePeriod": { "type": "integer", "description": "Due period.", "format": "int32", "nullable": true }, "SellingPrice": { "type": "string", "description": "Selling price.", "nullable": true }, "CurrencyId": { "type": "string", "description": "Currency id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "PaymentTypeId": { "type": "string", "description": "Payment type id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "TextItemVatRateId": { "type": "string", "description": "Text item VAT rate id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "PriceListItemVatRateId": { "type": "string", "description": "Price list item VAT rate id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "DocumentVariableSymbolSource": { "description": "Variable symbol source.", "oneOf": [ { "$ref": "#/components/schemas/DocumentVariableSymbolSourceEnum" } ] } } }, "DocumentVariableSymbolSourceEnum": { "type": "string", "description": "Document variable symbol source type.

Enum member description:

Number value   String value   Description   Warning
0   DocumentNumber   From document number.   
1   BusinessPartnerNumber   From business partner number.   
2   BusinessPartnerContractNumber   From business partner contract number.   
", "x-enumNames": [ "DocumentNumber", "BusinessPartnerNumber", "BusinessPartnerContractNumber" ], "enum": [ "DocumentNumber", "BusinessPartnerNumber", "BusinessPartnerContractNumber" ] }, "BusinessPartnerAdditionalDetailsDto": { "type": "object", "description": "Business partner additional details.", "additionalProperties": false, "properties": { "Groups": { "type": "string", "description": "Groups.", "nullable": true }, "Keys": { "type": "string", "description": "Keys.", "nullable": true }, "Message": { "type": "string", "description": "Message", "nullable": true } } }, "BusinessPartnerDeliveryAddressDto": { "type": "object", "description": "BusinessPartner delivery address.", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Entity id.", "format": "guid", "example": "00000000-0000-0000-0000-000000000000" }, "CompanyName": { "type": "string", "description": "Company name.", "nullable": true }, "Name": { "type": "string", "description": "Name. ", "nullable": true }, "Street": { "type": "string", "description": "Street. ", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Is default." }, "ModificationInfo": { "description": "Modification info.", "oneOf": [ { "$ref": "#/components/schemas/ModificationInfoDto" } ] } } }, "EntityListQueryResultDtoOfBusinessPartnerDto": { "type": "object", "description": "Filtered query result.", "additionalProperties": false, "properties": { "Items": { "type": "array", "description": "Items", "items": { "$ref": "#/components/schemas/BusinessPartnerDto" } }, "TotalItemCount": { "type": "integer", "description": "Total item count", "format": "int32" }, "Pagination": { "description": "Pagination", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PaginationInfoDto" } ] } } }, "EntityCreatedResponseDtoOfBusinessPartnerDto": { "type": "object", "description": "Common class for all entity created api responses.", "additionalProperties": false, "properties": { "Data": { "description": "Response data.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BusinessPartnerDto" } ] }, "Warnings": { "type": "array", "description": "Warnings.", "items": { "$ref": "#/components/schemas/WarningDto" } } } }, "CreateBusinessPartnerDto": { "type": "object", "additionalProperties": false, "required": [ "City" ], "properties": { "IdentificationNumber": { "type": "string", "description": "Identification number. ", "maxLength": 15, "minLength": 0, "nullable": true }, "TaxIdentificationNumber": { "type": "string", "description": "Tax identification number.", "nullable": true }, "CompanyName": { "type": "string", "description": "Company name.", "nullable": true }, "Name": { "type": "string", "description": "Name.", "nullable": true }, "Street": { "type": "string", "description": "Street.", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "maxLength": 15, "minLength": 0, "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "minLength": 1, "nullable": false }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "MobilePhoneNumber": { "type": "string", "description": "Mobile phone number.", "nullable": true }, "FaxNumber": { "type": "string", "description": "Fax number.", "nullable": true }, "Web": { "type": "string", "description": "Web.", "nullable": true }, "Note": { "type": "string", "description": "Note.", "nullable": true }, "InternalNote": { "type": "string", "description": "Internal note.", "nullable": true }, "BusinessDetails": { "description": "Business details.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CreateBusinessPartnerBusinessDetailsDto" } ] }, "DeliveryAddresses": { "type": "array", "description": "Delivery addresses.", "items": { "$ref": "#/components/schemas/CreateBusinessPartnerDeliveryAddressDto" } }, "RegionId": { "type": "string", "description": "Region.", "format": "guid", "nullable": true } } }, "CreateBusinessPartnerBusinessDetailsDto": { "type": "object", "description": "Create business partner business details.", "additionalProperties": false, "properties": { "Number": { "type": "string", "description": "Number.", "nullable": true }, "Contract": { "type": "string", "description": "Contract.", "nullable": true }, "DuePeriod": { "type": "integer", "description": "Due period.", "format": "int32", "maximum": 2000.0, "minimum": 0.0, "nullable": true }, "DuePeriodForLiabilities": { "type": "integer", "description": "Due period for liabilities.", "format": "int32", "maximum": 2000.0, "minimum": 0.0, "nullable": true }, "IsCustomer": { "type": "boolean", "description": "True, if business partner is customer." }, "IsSupplier": { "type": "boolean", "description": "True, if business partner is supplier." }, "DocumentVariableSymbolSource": { "description": "Variable symbol source.", "oneOf": [ { "$ref": "#/components/schemas/DocumentVariableSymbolSourceEnum" } ] }, "PaymentTypeId": { "type": "string", "description": "Payment type id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "Message": { "type": "string", "description": "Message.", "nullable": true }, "CentreId": { "type": "string", "description": "Centre id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "ActivityId": { "type": "string", "description": "Activity id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "TextItemVatRateId": { "type": "string", "description": "Text item VAT rate id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" }, "PriceListItemVatRateId": { "type": "string", "description": "Price list item VAT rate id.", "format": "guid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateBusinessPartnerDeliveryAddressDto": { "type": "object", "description": "Create business partner delivery address.", "additionalProperties": false, "properties": { "CompanyName": { "type": "string", "description": "Company name.", "nullable": true }, "Name": { "type": "string", "description": "Name. ", "nullable": true }, "Street": { "type": "string", "description": "Street. ", "nullable": true }, "PostCode": { "type": "string", "description": "Post code.", "nullable": true }, "Division": { "type": "string", "description": "Division.", "nullable": true }, "City": { "type": "string", "description": "City.", "nullable": true }, "Country": { "type": "string", "description": "Country.", "nullable": true }, "Email": { "type": "string", "description": "Email.", "nullable": true }, "PhoneNumber": { "type": "string", "description": "Phone number.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Is default." } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "Api-Key", "in": "header" }, "oauth2": { "type": "oauth2", "flows": { "clientCredentials": { "authorizationUrl": "https://ucet.pohoda.cz/connect/authorize", "tokenUrl": "https://ucet.pohoda.cz/connect/token", "scopes": { "Mph.OpenApi.Access.Cz": "mPOHODA Open API" } } } } } } }